{"openapi":"3.1.0","info":{"title":"Point11 API","version":"1","description":"The Point11 API does what you do in the dashboard: read your campaigns and results, and start the same work. The same requests reach the MCP server (`/api/mcp`) and the CLI. New here? The [guide](https://point11.ai/docs/mcp/overview) covers connecting, API keys, and AI assistants.\n\nSend `Authorization: Bearer <credential>`: an API key from **Settings > API keys** (`p11_…`, acting for one organization with the access you gave it), or a signed-in user's OAuth access token with `Point11-Organization` set to your organization ID from **Settings > API keys**.\n\nReads are `GET`; changes are `POST` with a JSON body and a new UUID in `Idempotency-Key`. Retry with the same key: a create or a start answers its first result again, and any other write runs again and answers the state it reached. Lists take `limit` and `cursor` and return `{ data, nextCursor }`. Longer work answers `202`; follow it with `GET /api/v1/platform/runs-v2/{id}`. A streaming request also answers `Accept: text/event-stream` with its live events.\n\nEvery error has a `code`, a `message`, a `request_id`, and sometimes `details`. `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` report your request budget.\n\nThe [capability table](https://point11.ai/api/parity.md) shows which dashboard actions the API, MCP server, and CLI reach.","termsOfService":"https://point11.ai/terms","contact":{"name":"Point11","url":"https://point11.ai"},"license":{"name":"Proprietary. See the Point11 Terms of Service","url":"https://point11.ai/terms"}},"servers":[{"url":"https://point11.ai"}],"tags":[{"name":"agents","x-displayName":"Agents","description":"Create and manage your voice and chat agents, and read their conversations and analytics."},{"name":"alpha","x-displayName":"Alpha","description":"Work with Alpha, your AI marketing assistant: chats, generated files and ads, brand kits, landing pages and their leads, and the apps you connect."},{"name":"billing","x-displayName":"Billing","description":"See your usage and credits, and manage subscriptions and payment methods."},{"name":"business","x-displayName":"Business profiles","description":"Manage what Point11 knows about your business: your products (revenue lines in this API), customers, audiences, goals, CRM connections and imports, and the calendar rules your campaigns follow."},{"name":"campaigns","x-displayName":"Campaigns","description":"See every campaign in one place (calendar, summaries, activity), and pause, resume, archive or delete any of them."},{"name":"collaboration","x-displayName":"Comments","description":"Comment on results, mention teammates, and follow threads."},{"name":"discovery","x-displayName":"Discovery","description":"Launch Discovery campaigns and read what they find: market, brand, competitor, customer, channel and product reports, maps, rosters and saved reports."},{"name":"experience","x-displayName":"Experience","description":"Run Experience campaigns that use your website and app the way real customers do, and read their journeys and analytics. Manage the test accounts and app builds they use."},{"name":"inspector","x-displayName":"Inspector","description":"Scan a website, benchmark it against competitors, and read every check and result."},{"name":"account","x-displayName":"Organization and members","description":"Manage your organization, members and invitations, API keys, branding, notifications, AI settings and the audit log."},{"name":"platform","x-displayName":"Progress and reports","description":"Follow long-running work to completion (every `202` answer points here), and read admin reports."},{"name":"reports","x-displayName":"Reports","description":"Build reports over Discovery, Experience and Research results: list the datasets each product offers, read and export a report's table, and save, list, archive and delete reports."},{"name":"research","x-displayName":"Research","description":"Design and launch Research studies, preview interviews, and read conversations and results."},{"name":"sites","x-displayName":"Sites","description":"Create and manage hosted sites and their custom domains."},{"name":"support","x-displayName":"Support","description":"Message Point11 support, or open your in-app Help guide."}],"components":{"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer","bearerFormat":"p11_*","description":"Point11 API key — create one under Settings → API keys. Pass as `Authorization: Bearer <key>`. Keys are org-scoped; every request operates on the org that owns the key."},"oauth":{"type":"oauth2","description":"WorkOS AuthKit OAuth for a Point11 user (authorization code with PKCE). Request the resource `https://point11.ai/api/v1`. Send `Point11-Organization` to act in one of the user's organizations; the user's role there governs every operation.","flows":{"authorizationCode":{"authorizationUrl":"https://auth.point11.ai/oauth2/authorize","tokenUrl":"https://auth.point11.ai/oauth2/token","refreshUrl":"https://auth.point11.ai/oauth2/token","scopes":{"openid":"Identify the signed-in user.","offline_access":"Refresh tokens."}}}}},"schemas":{"JsonValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"$ref":"#/components/schemas/JsonValue"}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/JsonValue"}}]},"OperationError":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/JsonValue"}}},"required":["code","message","request_id"],"additionalProperties":false,"description":"The one error envelope every catalog operation answers with."},"InspectorActivitiesGetResponse":{"type":"object","properties":{"product":{"type":"string","enum":["studio","advisor","alpha","inspector"]},"reading":{"$ref":"#/components/schemas/InspectorReading"},"subject":{"anyOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["creative_project","conversation","scan"]},"id":{"type":"string","minLength":1},"name":{"type":"string"}},"required":["kind","id","name"],"additionalProperties":false},{"type":"null"}]},"observedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["product","reading","subject","observedAt"],"additionalProperties":false},"InspectorScansStartRequest":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"Full URL to scan (e.g. https://example.com)"}},"required":["url"],"additionalProperties":false},"InspectorScansStartResponse":{"type":"object","properties":{"runId":{"type":"string","description":"Billing run id; poll with platform_runs_get_v2"},"status":{"type":"string","enum":["pending","complete"],"description":"pending = the scan is running; complete = this operation already finished"},"scanId":{"type":"string"},"competitors":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"scanId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The competitor's scan, which its scan's report lists; null when refused"},"refusal":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Why the competitor's scan could not start (its URL safety check, a daily limit, Billing); else null"}},"required":["url","scanId","refusal"],"additionalProperties":false},"description":"The competitors scanned beside the site, up to 5: those the organization's business profile for the site names; empty when it names none"}},"required":["runId","status","scanId","competitors"],"additionalProperties":false},"InspectorScansGetV2Response":{"type":"object","properties":{"status":{"type":"string","enum":["pending","crawling","checking","scoring","complete","error","halted"]},"scanId":{"type":"string"},"url":{"type":"string"},"hostname":{"type":"string"},"grade":{"anyOf":[{"type":"string"},{"type":"null"}]},"scoreOverall":{"anyOf":[{"type":"number"},{"type":"null"}]},"currentStep":{"type":"string"},"percent":{"type":"number"},"failure":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Why an errored or halted scan ended, in words for the customer; else null"},"report":{"anyOf":[{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"progress"},"siteUrl":{"type":"string"},"progress":{"type":"object","properties":{"currentStep":{"type":"string"},"percent":{"type":"number"},"steps":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"status":{"type":"string","enum":["pending","running","complete","error","skipped"]},"checkCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"error":{"anyOf":[{"type":"string"},{"type":"null"}]},"startedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label","status","checkCount","error","startedAt","completedAt"],"additionalProperties":false}},"scanStartedAt":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["currentStep","percent","steps","scanStartedAt"],"additionalProperties":false}},"required":["kind","siteUrl","progress"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"complete"},"result":{"type":"object","properties":{"scanId":{"type":"string"},"url":{"type":"string"},"hostname":{"type":"string"},"contentLanguage":{"type":"string","enum":["en","fr","es","de","pt","ja","it","nl","sv","cs","pl","tr","ru","zh-Hans","ko","ar"]},"status":{"type":"string","enum":["pending","crawling","checking","scoring","complete","error","halted"]},"checks":{"type":"array","items":{"type":"object","properties":{"checkId":{"type":"string"},"checkName":{"type":"string"},"status":{"type":"string","enum":["pass","warning","fail","na"]},"confidenceLabel":{"type":"string","enum":["confirmed","high_confidence","likely","detected"]},"weight":{"anyOf":[{"type":"number","const":12},{"type":"number","const":3.5},{"type":"number","const":2},{"type":"number","const":0.75}]},"group":{"type":"string","enum":["foundation","chatgpt","gemini","claude","grok"]},"finding":{"type":"string"},"impact":{"type":"string"},"remediation":{"type":"string"},"screenshotUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"pagesScanned":{"type":"array","items":{"type":"string"}},"weightTier":{"type":"string","enum":["critical","high","medium","low"]},"rawData":{"type":"object","properties":{"agents":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"blocked":{"type":"boolean"},"robotsBlocked":{"type":"boolean"},"probeBlocked":{"type":"boolean"},"robotsPartialBlocks":{"type":"array","items":{"type":"string"}},"deadPathsFiltered":{"type":"array","items":{"type":"string"}},"authPathsFiltered":{"type":"array","items":{"type":"string"}}},"required":["name","blocked","robotsBlocked","probeBlocked","robotsPartialBlocks","deadPathsFiltered","authPathsFiltered"],"additionalProperties":false}},"score":{"anyOf":[{"type":"number"},{"type":"null"}]},"scorePercent":{"type":"number"},"lcp":{"type":"number"},"lcpSec":{"type":"number"}},"additionalProperties":false}},"required":["checkId","checkName","status","confidenceLabel","weight","group","finding","impact","remediation","screenshotUrl","pagesScanned","weightTier"],"additionalProperties":false}},"score":{"anyOf":[{"type":"object","properties":{"crawlers":{"type":"array","items":{"type":"object","properties":{"crawlerId":{"type":"string","enum":["chatgpt","gemini","claude","grok"]},"score":{"type":"number"},"grade":{"type":"string"},"counts":{"type":"object","properties":{"pass":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"warning":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"fail":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"na":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["pass","warning","fail","na"],"additionalProperties":false}},"required":["crawlerId","score","grade","counts"],"additionalProperties":false}},"checksScored":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"checksTotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"scoreOverall":{"type":"number"},"grade":{"type":"string"},"scoreReliability":{"type":"string","enum":["high","medium","low"]},"qualifiedGrade":{"type":"boolean"},"incompleteAssessment":{"type":"boolean"}},"required":["crawlers","checksScored","checksTotal","scoreOverall","grade"],"additionalProperties":false},{"type":"null"}]},"confidence":{"anyOf":[{"type":"object","properties":{"level":{"type":"string","enum":["high","medium","low"]},"score":{"type":"number"},"factors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"impact":{"type":"string","enum":["positive","negative","neutral"]},"detail":{"type":"string"}},"required":["name","impact","detail"],"additionalProperties":false}}},"required":["level","score","factors"],"additionalProperties":false},{"type":"null"}]},"progress":{"type":"object","properties":{"currentStep":{"type":"string"},"percent":{"type":"number"},"steps":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"status":{"type":"string","enum":["pending","running","complete","error","skipped"]},"checkCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"error":{"anyOf":[{"type":"string"},{"type":"null"}]},"startedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label","status","checkCount","error","startedAt","completedAt"],"additionalProperties":false}},"scanStartedAt":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["currentStep","percent","steps","scanStartedAt"],"additionalProperties":false},"durationMs":{"type":"number"},"startedAt":{"type":"string"},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"error":{"anyOf":[{"type":"string"},{"type":"null"}]},"limitedScan":{"type":"boolean"},"scanLimitations":{"type":"array","items":{"type":"string"}},"wafSummary":{"anyOf":[{"type":"object","properties":{"detected":{"type":"boolean"},"provider":{"anyOf":[{"type":"string"},{"type":"null"}]},"pagesAffected":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"checksAffected":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["detected","provider","pagesAffected","checksAffected"],"additionalProperties":false},{"type":"null"}]},"spaDetected":{"type":"boolean"},"aiSummary":{"description":"The narrative this scan stored before Inspector stopped writing one; absent for every later scan","type":"object","properties":{"version":{"type":"string","const":"v2"},"brandName":{"type":"string","minLength":1},"mainOffering":{"type":"string","minLength":1},"targetCustomer":{"type":"string","minLength":1},"siteObjective":{"type":"string","minLength":1},"searchQuery":{"type":"string","minLength":1},"industryCategory":{"type":"string","minLength":1},"whyItMatters":{"type":"string","minLength":1},"performance":{"anyOf":[{"type":"string"},{"type":"null"}]},"discoverability":{"anyOf":[{"type":"string"},{"type":"null"}]},"accessibility":{"anyOf":[{"type":"string"},{"type":"null"}]},"businessImpact":{"type":"string","minLength":1},"generatedAt":{"type":"string","minLength":1},"modelId":{"type":"string","minLength":1}},"required":["version","brandName","mainOffering","targetCustomer","siteObjective","searchQuery","industryCategory","whyItMatters","performance","discoverability","accessibility","businessImpact","generatedAt","modelId"],"additionalProperties":false},"homepageScreenshot":{"anyOf":[{"type":"string"},{"type":"null"}]},"homepageScreenshotSource":{"anyOf":[{"type":"string","enum":["sandbox","psi","puppeteer"]},{"type":"null"}]},"mobileScreenshot":{"anyOf":[{"type":"string"},{"type":"null"}]},"mobileScreenshotSource":{"anyOf":[{"type":"string","enum":["sandbox","psi","puppeteer"]},{"type":"null"}]},"renderEvidence":{"anyOf":[{"type":"object","properties":{"version":{"type":"number","const":1},"source":{"type":"string","const":"sandbox"},"status":{"type":"string","enum":["ok","unavailable"]},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"phase":{"anyOf":[{"type":"string","enum":["environment","setup","render"]},{"type":"null"}]},"detail":{"type":"null"},"agentBrowserVersion":{"anyOf":[{"type":"string"},{"type":"null"}]},"elapsedMs":{"anyOf":[{"type":"number"},{"type":"null"}]},"allowedDomains":{"maxItems":0,"type":"array","items":{"not":{}}},"rejectedDomains":{"maxItems":0,"type":"array","items":{"not":{}}},"pages":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"url":{"type":"string"},"finalUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"device":{"type":"string","enum":["desktop","mobile"]},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"textLength":{"anyOf":[{"type":"number"},{"type":"null"}]},"snapshot":{"anyOf":[{"type":"string"},{"type":"null"}]},"snapshotTruncated":{"type":"boolean"},"vitals":{"anyOf":[{"type":"object","properties":{"lcp":{"anyOf":[{"type":"number"},{"type":"null"}]},"cls":{"anyOf":[{"type":"number"},{"type":"null"}]},"ttfb":{"anyOf":[{"type":"number"},{"type":"null"}]},"fcp":{"anyOf":[{"type":"number"},{"type":"null"}]},"inp":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["lcp","cls","ttfb","fcp","inp"],"additionalProperties":false},{"type":"null"}]},"a11y":{"anyOf":[{"type":"object","properties":{"axeCoreVersion":{"anyOf":[{"type":"string"},{"type":"null"}]},"violationCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"incompleteCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"passes":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"violations":{"maxItems":0,"type":"array","items":{"not":{}}}},"required":["axeCoreVersion","violationCount","incompleteCount","passes","violations"],"additionalProperties":false},{"type":"null"}]},"errorCount":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"failures":{"maxItems":0,"type":"array","items":{"not":{}}}},"required":["label","url","finalUrl","device","title","textLength","snapshot","snapshotTruncated","vitals","a11y","errorCount","failures"],"additionalProperties":false}}},"required":["version","source","status","reason","detail","agentBrowserVersion","elapsedMs","allowedDomains","rejectedDomains","pages"],"additionalProperties":false},{"type":"null"}]},"crawlSummary":{"anyOf":[{"type":"object","properties":{"pagesFound":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"formPagesFound":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"ecommerceDetected":{"type":"boolean"},"ecommercePlatform":{"anyOf":[{"type":"string"},{"type":"null"}]},"ecommerceSignals":{"type":"array","items":{"type":"string"}},"isSpa":{"type":"boolean"}},"required":["pagesFound","formPagesFound","ecommerceDetected","ecommercePlatform","ecommerceSignals","isSpa"],"additionalProperties":false},{"type":"null"}]}},"required":["scanId","url","hostname","status","checks","score","confidence","progress","durationMs","startedAt","completedAt","error","limitedScan","scanLimitations","wafSummary","spaDetected","renderEvidence","crawlSummary"],"additionalProperties":false},"crawlerScores":{"type":"object","properties":{"crawlers":{"type":"array","items":{"type":"object","properties":{"crawler":{"type":"object","properties":{"id":{"type":"string","enum":["chatgpt","gemini","claude","grok"]},"name":{"type":"string"},"company":{"type":"string"},"description":{"type":"string"},"color":{"type":"string"},"darkColor":{"type":"string"}},"required":["id","name","company","description","color","darkColor"],"additionalProperties":false},"score":{"anyOf":[{"type":"number"},{"type":"null"}]},"grade":{"type":"string"},"checks":{"type":"array","items":{"type":"object","properties":{"checkId":{"type":"string"},"checkName":{"type":"string"},"status":{"type":"string","enum":["pass","warning","fail","na"]},"group":{"type":"string","enum":["foundation","chatgpt","gemini","claude","grok"]},"isUniversal":{"type":"boolean"},"confidenceLabel":{"type":"string","enum":["confirmed","high_confidence","likely","detected"]},"finding":{"type":"string"},"impact":{"type":"string"},"remediation":{"type":"string"},"weightTier":{"type":"string","enum":["critical","high","medium","low"]}},"required":["checkId","checkName","status","group","isUniversal","confidenceLabel","finding","impact","remediation","weightTier"],"additionalProperties":false}},"counts":{"type":"object","properties":{"pass":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"warning":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"fail":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"na":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["pass","warning","fail","na","total"],"additionalProperties":false}},"required":["crawler","score","grade","checks","counts"],"additionalProperties":false}}},"required":["crawlers"],"additionalProperties":false},"prefetchedSummary":{"anyOf":[{"type":"object","properties":{"version":{"type":"string","const":"v2"},"brandName":{"type":"string","minLength":1},"mainOffering":{"type":"string","minLength":1},"targetCustomer":{"type":"string","minLength":1},"siteObjective":{"type":"string","minLength":1},"searchQuery":{"type":"string","minLength":1},"industryCategory":{"type":"string","minLength":1},"whyItMatters":{"type":"string","minLength":1},"performance":{"anyOf":[{"type":"string"},{"type":"null"}]},"discoverability":{"anyOf":[{"type":"string"},{"type":"null"}]},"accessibility":{"anyOf":[{"type":"string"},{"type":"null"}]},"businessImpact":{"type":"string","minLength":1},"generatedAt":{"type":"string","minLength":1},"modelId":{"type":"string","minLength":1}},"required":["version","brandName","mainOffering","targetCustomer","siteObjective","searchQuery","industryCategory","whyItMatters","performance","discoverability","accessibility","businessImpact","generatedAt","modelId"],"additionalProperties":false},{"type":"null"}],"description":"The narrative this scan stored before Inspector stopped writing one; null for every later scan"},"industryPercentile":{"anyOf":[{"type":"number"},{"type":"null"}]},"percentileDetail":{"anyOf":[{"type":"object","properties":{"rankPct":{"type":"string"},"industryName":{"type":"string"}},"required":["rankPct","industryName"],"additionalProperties":false},{"type":"null"}]},"isPartialScan":{"type":"boolean"},"favicon":{"anyOf":[{"type":"object","properties":{"url":{"type":"string","description":"The stored favicon: a public object URL"},"tone":{"type":"string","enum":["dark","light","mixed","unknown"]},"transparent":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"needsLightBackplate":{"type":"boolean"},"needsDarkBackplate":{"type":"boolean"}},"required":["url","tone","transparent","needsLightBackplate","needsDarkBackplate"],"additionalProperties":false},{"type":"null"}],"description":"The favicon Point11 fetched and stored for the scanned website; null until one is stored, and the site draws its initial"},"competitors":{"type":"array","items":{"type":"object","properties":{"scanId":{"type":"string","description":"The competitor's own scan; read it with this operation"},"url":{"type":"string"},"hostname":{"type":"string"},"status":{"type":"string","enum":["pending","crawling","checking","scoring","complete","error","halted"]},"scoreOverall":{"anyOf":[{"type":"number"},{"type":"null"}]},"screenshot":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The competitor's homepage screenshot, once its scan stored one"},"favicon":{"anyOf":[{"type":"object","properties":{"url":{"type":"string","description":"The stored favicon: a public object URL"},"tone":{"type":"string","enum":["dark","light","mixed","unknown"]},"transparent":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"needsLightBackplate":{"type":"boolean"},"needsDarkBackplate":{"type":"boolean"}},"required":["url","tone","transparent","needsLightBackplate","needsDarkBackplate"],"additionalProperties":false},{"type":"null"}]}},"required":["scanId","url","hostname","status","scoreOverall","screenshot","favicon"],"additionalProperties":false},"description":"The competitors' scans run beside this one (those its organization's profile for the site names), in the order they started; empty when none was"}},"required":["kind","result","crawlerScores","prefetchedSummary","industryPercentile","percentileDetail","isPartialScan","favicon","competitors"],"additionalProperties":false}]},{"type":"null"}]}},"required":["status","scanId","url","hostname","grade","scoreOverall","currentStep","percent","failure","report"],"additionalProperties":false},"InspectorScansListV2Response":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"scanId":{"type":"string"},"url":{"type":"string"},"hostname":{"type":"string"},"status":{"type":"string","enum":["pending","crawling","checking","scoring","complete","error","halted"]},"grade":{"anyOf":[{"type":"string"},{"type":"null"}]},"scoreOverall":{"anyOf":[{"type":"number"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"scoreChatgpt":{"anyOf":[{"type":"number"},{"type":"null"}]},"scoreGemini":{"anyOf":[{"type":"number"},{"type":"null"}]},"scoreClaude":{"anyOf":[{"type":"number"},{"type":"null"}]},"scoreGrok":{"anyOf":[{"type":"number"},{"type":"null"}]},"checksScored":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"trigger":{"type":"string","enum":["manual","monitoring"]},"visibility":{"type":"string","enum":["public","org"]},"startedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"completedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"archivedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"deletedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"lifecycleStatus":{"type":"string","enum":["active","archived","deleted"]},"percentile":{"anyOf":[{"type":"number"},{"type":"null"}]},"favicon":{"anyOf":[{"type":"object","properties":{"url":{"type":"string","description":"The stored favicon: a public object URL"},"tone":{"type":"string","enum":["dark","light","mixed","unknown"]},"transparent":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"needsLightBackplate":{"type":"boolean"},"needsDarkBackplate":{"type":"boolean"}},"required":["url","tone","transparent","needsLightBackplate","needsDarkBackplate"],"additionalProperties":false},{"type":"null"}],"description":"The favicon Point11 fetched and stored for the scanned website; null until one is stored, and the site draws its initial"}},"required":["scanId","url","hostname","status","grade","scoreOverall","createdAt","scoreChatgpt","scoreGemini","scoreClaude","scoreGrok","checksScored","trigger","visibility","startedAt","completedAt","updatedAt","archivedAt","deletedAt","lifecycleStatus","percentile","favicon"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"totalCount":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"offset":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["data","nextCursor","totalCount","offset"],"additionalProperties":false},"InspectorScansArchiveRequest":{"type":"object","properties":{"ids":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"string","minLength":1},"description":"Ids of the records to transition (1–100)"}},"required":["ids"],"additionalProperties":false},"InspectorScansArchiveResponse":{"type":"object","properties":{"requestedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"foundCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"changedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"unchangedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"missingCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["requestedCount","foundCount","changedCount","unchangedCount","missingCount"],"additionalProperties":false},"InspectorScansRestoreRequest":{"type":"object","properties":{"ids":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"string","minLength":1},"description":"Ids of the records to transition (1–100)"}},"required":["ids"],"additionalProperties":false},"InspectorScansRestoreResponse":{"type":"object","properties":{"requestedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"foundCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"changedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"unchangedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"missingCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["requestedCount","foundCount","changedCount","unchangedCount","missingCount"],"additionalProperties":false},"InspectorScansDeleteRequest":{"type":"object","properties":{"ids":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"string","minLength":1},"description":"Ids of the records to transition (1–100)"}},"required":["ids"],"additionalProperties":false},"InspectorScansDeleteResponse":{"type":"object","properties":{"requestedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"foundCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"changedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"unchangedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"missingCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["requestedCount","foundCount","changedCount","unchangedCount","missingCount"],"additionalProperties":false},"InspectorScanResultsGetV2Response":{"type":"object","properties":{"summary":{"type":"object","properties":{"scanId":{"type":"string"},"url":{"type":"string"},"hostname":{"type":"string"},"status":{"type":"string"},"grade":{"anyOf":[{"type":"string"},{"type":"null"}]},"scoreOverall":{"anyOf":[{"type":"number"},{"type":"null"}]},"crawlers":{"type":"array","items":{"type":"object","properties":{"crawlerId":{"type":"string"},"score":{"type":"number"},"maxScore":{"type":"number"},"checksScored":{"type":"number"},"checksTotal":{"type":"number"}},"required":["crawlerId","score","maxScore","checksScored","checksTotal"],"additionalProperties":false}},"checksTotal":{"type":"number"},"checksScored":{"type":"number"},"durationMs":{"type":"number"},"startedAt":{"type":"string"},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["scanId","url","hostname","status","grade","scoreOverall","crawlers","checksTotal","checksScored","durationMs","startedAt","completedAt"],"additionalProperties":false},"checks":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"checkId":{"type":"string"},"checkName":{"type":"string"},"group":{"type":"string"},"status":{"type":"string","enum":["pass","warning","fail","na"]},"weight":{"type":"number"},"finding":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["checkId","checkName","group","status","weight","finding"],"additionalProperties":false},{"$ref":"#/components/schemas/InspectorScanChecksGetResponse"}]}}},"required":["summary","checks"],"additionalProperties":false},"InspectorScanChecksGetResponse":{"type":"object","properties":{"checkId":{"type":"string"},"checkName":{"type":"string"},"group":{"type":"string"},"status":{"type":"string","enum":["pass","warning","fail","na"]},"weight":{"type":"number"},"finding":{"anyOf":[{"type":"string"},{"type":"null"}]},"impact":{"anyOf":[{"type":"string"},{"type":"null"}]},"remediation":{"anyOf":[{"type":"string"},{"type":"null"}]},"pagesScanned":{"type":"array","items":{"type":"string"}},"rawData":{"type":"object","properties":{"agents":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"blocked":{"type":"boolean"},"robotsBlocked":{"type":"boolean"},"probeBlocked":{"type":"boolean"},"robotsPartialBlocks":{"type":"array","items":{"type":"string"}},"deadPathsFiltered":{"type":"array","items":{"type":"string"}},"authPathsFiltered":{"type":"array","items":{"type":"string"}}},"required":["name","blocked","robotsBlocked","probeBlocked","robotsPartialBlocks","deadPathsFiltered","authPathsFiltered"],"additionalProperties":false}},"score":{"anyOf":[{"type":"number"},{"type":"null"}]},"scorePercent":{"type":"number"},"lcp":{"type":"number"},"lcpSec":{"type":"number"}},"additionalProperties":false}},"required":["checkId","checkName","group","status","weight","finding","impact","remediation","pagesScanned"],"additionalProperties":false},"InspectorCompetitorSuggestionsCreateRequest":{"type":"object","properties":{"hostname":{"type":"string","minLength":3,"maxLength":253}},"required":["hostname"],"additionalProperties":false,"deprecated":true},"InspectorCompetitorSuggestionsCreateResponse":{"type":"object","properties":{"business":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"category":{"type":"string","minLength":1,"maxLength":200},"description":{"type":"string","minLength":1,"maxLength":800}},"required":["name","category","description"],"additionalProperties":false},"competitors":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"domain":{"type":"string","minLength":3,"maxLength":253}},"required":["name","domain"],"additionalProperties":false}}},"required":["business","competitors"],"additionalProperties":false},"InspectorCompetitorSuggestionsCreateV2Request":{"type":"object","properties":{"hostname":{"type":"string","minLength":3,"maxLength":253}},"required":["hostname"],"additionalProperties":false},"InspectorCompetitorSuggestionsCreateV2Response":{"type":"object","properties":{"business":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"category":{"type":"string","minLength":1,"maxLength":200},"description":{"type":"string","minLength":1,"maxLength":800}},"required":["name","category","description"],"additionalProperties":false},"competitors":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"domain":{"type":"string","minLength":3,"maxLength":253}},"required":["name","domain"],"additionalProperties":false}}},"required":["business","competitors"],"additionalProperties":false},"InspectorSiteInspectionsRunResponse":{"type":"object","properties":{"inspection":{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"requestedUrl":{"type":"string"},"finalUrl":{"type":"string"},"redirects":{"maxItems":10,"type":"array","items":{"type":"string"}},"status":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"contentType":{"anyOf":[{"type":"string"},{"type":"null"}]},"checkedAt":{"type":"string"},"method":{"type":"string","enum":["http","http+rendered"]},"platform":{"maxItems":40,"type":"array","items":{"type":"object","properties":{"category":{"type":"string","enum":["commerce","cms","theme","framework","search","reviews","email_sms","subscriptions","affiliate","support_chat","consent","payments","edge"]},"name":{"type":"string","minLength":1,"maxLength":120},"version":{"anyOf":[{"type":"string","minLength":1,"maxLength":60},{"type":"null"}]},"confidence":{"type":"string","enum":["high","medium","low"]},"signals":{"minItems":1,"maxItems":8,"type":"array","items":{"type":"string","minLength":1,"maxLength":300}}},"required":["category","name","version","confidence","signals"],"additionalProperties":false}},"facts":{"maxItems":60,"type":"array","items":{"type":"object","properties":{"surface":{"type":"string","enum":["robots","llms","markup","forms","negotiation","rendered"]},"fact":{"type":"string","minLength":1,"maxLength":600},"at":{"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]}},"required":["surface","fact","at"],"additionalProperties":false}},"text":{"anyOf":[{"type":"object","properties":{"excerpt":{"type":"string","maxLength":40000},"truncated":{"type":"boolean"}},"required":["excerpt","truncated"],"additionalProperties":false},{"type":"null"}]},"body":{"anyOf":[{"type":"object","properties":{"bytes":{"type":"integer","minimum":0,"maximum":9007199254740991},"sha256":{"type":"string"}},"required":["bytes","sha256"],"additionalProperties":false},{"type":"null"}]},"limits":{"maxItems":12,"type":"array","items":{"type":"string","minLength":1,"maxLength":300}}},"required":["ok","requestedUrl","finalUrl","redirects","status","contentType","checkedAt","method","platform","facts","text","body","limits"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"requestedUrl":{"type":"string"},"checkedAt":{"type":"string"},"reason":{"type":"string","enum":["outside_site","unsafe","blocked_by_challenge","not_found","unreachable","timeout"]},"status":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"blockedBy":{"anyOf":[{"type":"string","maxLength":60},{"type":"null"}]},"detail":{"type":"string","maxLength":600}},"required":["ok","requestedUrl","checkedAt","reason","status","blockedBy","detail"],"additionalProperties":false}]}},"required":["inspection"],"additionalProperties":false},"DiscoveryCampaignsListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"status":{"type":"string","enum":["active","paused","archived","deleted"]},"targetKind":{"type":"string","enum":["profile","physical_locations"]},"businessProfileId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The business profile whose site it measures; null while none is bound. An Experience campaign on the same profile may name it as competitorSourceCampaignId."},"storeCount":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}],"description":"How many stores a physical_locations campaign measures now (a store its settings removed is not counted); null for any other campaign."},"customerCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The customers it shops: its customer target, which grows with its roster (campaigns.summaries.list.v2's customerCount)."},"forecastAudience":{"type":"boolean","description":"Whether its customers are its forecast's alone (forecast mode, as Bootup's Forecast campaign)."},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["campaignId","name","status","targetKind","businessProfileId","storeCount","customerCount","forecastAudience","createdAt","updatedAt"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"DiscoveryCampaignSettingsGetResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"businessProfileId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The business profile it runs on."},"mode":{"type":"string","enum":["current","forecast","both"],"description":"Whether it samples current customers, forecast customers, or both."},"engines":{"type":"array","items":{"type":"string","enum":["chatgpt","gemini","claude","grok"]},"description":"The assistants it asks."},"marginOfError":{"type":"number","description":"Its precision target: the margin of error, in percent."},"targetCustomerCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The customers it samples; it grows with the roster."},"rosterCustomerCount":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}],"description":"The customers on the campaign now, whom its runs interview: its roster, less anyone removed. A named removal lowers it and leaves targetCustomerCount. Null until its first run has chosen them."},"targetKind":{"anyOf":[{"type":"string","enum":["profile","physical_locations"]},{"type":"null"}],"description":"What it measures; null while a first campaign's setup has not settled it."},"locationContexts":{"type":"array","items":{"$ref":"#/components/schemas/DiscoveryLocationContextsItem"},"description":"The store locations it measures, as saved."},"locationCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"How many stores it measures now."},"stores":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"The store's key: name it in removeStoreKeys to stop measuring it."},"label":{"type":"string","description":"The store's name."},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Its street address, when it has one."},"googlePlaceId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Google Maps listing it was picked from, when it was."},"state":{"type":"string","enum":["setting_up","active","failed","removed"],"description":"setting_up until its customers are ready; active once they are; failed when its setup ended without them; removed once a Save stopped measuring it."},"addedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}],"description":"When a Save added it after launch; null for a store it launched with."},"removedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}],"description":"When a Save stopped measuring it; its results before then stay."}},"required":["key","label","address","googlePlaceId","state","addedAt","removedAt"],"additionalProperties":false},"description":"Every store a location campaign has had, in launched order, removed ones included; empty for a brand-wide campaign."},"locationCoverageMode":{"type":"string","enum":["standard","one_per_location"],"description":"Whether every store location gets at least one customer (one_per_location)."},"targetedGroupIds":{"anyOf":[{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"type":"null"}],"description":"The audiences it was targeted at; null when not narrowed to audiences."},"targetedCustomerIds":{"anyOf":[{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"type":"null"}],"description":"The customers it was picked from; null when not hand-picked."},"settingsRevision":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Its settings revision: pass it as expectedSettingsRevision to discovery.campaign-settings-quotes.get and discovery.campaign-settings.update."}},"required":["id","businessProfileId","mode","engines","marginOfError","targetCustomerCount","rosterCustomerCount","targetKind","locationContexts","locationCount","stores","locationCoverageMode","targetedGroupIds","targetedCustomerIds","settingsRevision"],"additionalProperties":false},"DiscoveryCampaignSettingsQuotesGetResponse":{"type":"object","properties":{"settingsRevision":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The settings revision this quote read; pass it as expectedSettingsRevision."},"requiresReview":{"type":"boolean","description":"Whether the Save changes money or results, so Billing is asked about its work and a quoted estimate is re-checked; false when it changes only the name."},"changes":{"$ref":"#/components/schemas/DiscoveryChanges"},"estimate":{"$ref":"#/components/schemas/DiscoveryEstimate"},"billing":{"oneOf":[{"type":"object","properties":{"outcome":{"type":"string","const":"not_needed"}},"required":["outcome"],"additionalProperties":false},{"type":"object","properties":{"outcome":{"type":"string","const":"admitted"}},"required":["outcome"],"additionalProperties":false},{"type":"object","properties":{"outcome":{"type":"string","const":"refused"},"reason":{"type":"string","minLength":1,"description":"Billing's refusal reason."},"message":{"type":"string","minLength":1,"description":"Billing's refusal, in its own words."},"paymentDisputeHold":{"type":"boolean","description":"Whether the account is held for a payment dispute, which a new card does not lift."}},"required":["outcome","reason","message","paymentDisputeHold"],"additionalProperties":false}]},"resultsNote":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How the change reaches results; null when results do not change."},"reviewedEstimate":{"anyOf":[{"type":"object","properties":{"monthlyAfter":{"type":"integer","minimum":0,"maximum":9007199254740991},"unitPriceCents":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"oneTimeAmountCents":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]}},"required":["monthlyAfter","unitPriceCents","oneTimeAmountCents"],"additionalProperties":false,"description":"The estimate a quote returned (its reviewedEstimate): the Save is refused if it moved. Null saves at the current estimate."},{"type":"null"}],"description":"Pass to the update as reviewedEstimate; null when there is no estimate."},"customersLeaving":{"type":"array","items":{"type":"object","properties":{"customerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"joinedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["customerId","name","joinedAt"],"additionalProperties":false},"description":"Who a lower customer count removes when removeCustomerIds names no one: the newest joined first."}},"required":["settingsRevision","requiresReview","changes","estimate","billing","resultsNote","reviewedEstimate","customersLeaving"],"additionalProperties":false},"DiscoveryCampaignSettingsQuotesGetV2Response":{"type":"object","properties":{"settingsRevision":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The settings revision this quote read; pass it as expectedSettingsRevision."},"requiresReview":{"type":"boolean","description":"Whether the Save changes money or results, so Billing is asked about its work and a quoted estimate is re-checked; false when it changes only the name."},"changes":{"$ref":"#/components/schemas/DiscoveryChanges"},"estimate":{"$ref":"#/components/schemas/DiscoveryEstimate"},"billing":{"oneOf":[{"type":"object","properties":{"outcome":{"type":"string","const":"not_needed"}},"required":["outcome"],"additionalProperties":false},{"type":"object","properties":{"outcome":{"type":"string","const":"admitted"}},"required":["outcome"],"additionalProperties":false},{"type":"object","properties":{"outcome":{"type":"string","const":"refused"},"reason":{"type":"string","minLength":1,"description":"Billing's refusal reason."},"message":{"type":"string","minLength":1,"description":"Billing's refusal, in its own words."},"paymentDisputeHold":{"type":"boolean","description":"Whether the account is held for a payment dispute, which a new card does not lift."}},"required":["outcome","reason","message","paymentDisputeHold"],"additionalProperties":false}]},"resultsNote":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How the change reaches results; null when results do not change."},"reviewedEstimate":{"anyOf":[{"type":"object","properties":{"monthlyAfter":{"type":"integer","minimum":0,"maximum":9007199254740991},"unitPriceCents":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"oneTimeAmountCents":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]}},"required":["monthlyAfter","unitPriceCents","oneTimeAmountCents"],"additionalProperties":false,"description":"The estimate a quote returned (its reviewedEstimate): the Save is refused if it moved. Null saves at the current estimate."},{"type":"null"}],"description":"Pass to the update as reviewedEstimate; null when there is no estimate."},"customersLeaving":{"type":"array","items":{"type":"object","properties":{"customerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"joinedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["customerId","name","joinedAt"],"additionalProperties":false},"description":"Who a lower customer count removes when removeCustomerIds names no one: the newest joined first."}},"required":["settingsRevision","requiresReview","changes","estimate","billing","resultsNote","reviewedEstimate","customersLeaving"],"additionalProperties":false},"DiscoveryCampaignSettingsUpdateRequest":{"type":"object","properties":{"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The campaign's id."},"expectedSettingsRevision":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The settingsRevision the settings read (or a quote) returned."},"reviewedEstimate":{"anyOf":[{"type":"object","properties":{"monthlyAfter":{"type":"integer","minimum":0,"maximum":9007199254740991},"unitPriceCents":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"oneTimeAmountCents":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]}},"required":["monthlyAfter","unitPriceCents","oneTimeAmountCents"],"additionalProperties":false,"description":"The estimate a quote returned (its reviewedEstimate): the Save is refused if it moved. Null saves at the current estimate."},{"type":"null"}]},"changes":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120,"description":"The campaign's new name."},"engines":{"description":"The assistants the campaign asks from its next run: the whole set, at least one. Add, remove or swap; past conversations stay.","minItems":1,"maxItems":4,"type":"array","items":{"type":"string","enum":["chatgpt","gemini","claude","grok"]}},"engineCatchUp":{"description":"When an assistant is added: also run it once, within a day, for the customers this month's runs already refreshed (true when omitted), so its results are complete this month.","type":"boolean"},"customerCount":{"description":"How many customers it runs: the campaign's total, or, on a store campaign, the customers per store. Raising it adds eligible customers, then generates the rest; lowering it removes the newest joined first unless removeCustomerIds names who leaves.","type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"addCustomerIds":{"description":"Customers to add; each joins this month's calendar.","maxItems":1000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"removeCustomerIds":{"description":"Customers to remove; each leaves every later run at once and keeps its history.","maxItems":1000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"audience":{"description":"Who can be added: every eligible customer (all) or members of targetedGroupIds (groups). It never resamples the current customers.","type":"string","enum":["all","groups"]},"targetedGroupIds":{"description":"The audiences, with audience groups.","maxItems":1000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"removeCustomersOutsideAudience":{"description":"With a new audience: also remove the current customers outside it.","type":"boolean"},"removeStoreKeys":{"description":"Stores to stop measuring, by key: their customers leave at once and their history stays.","maxItems":309,"type":"array","items":{"type":"string","minLength":1,"maxLength":2000}},"addStores":{"$ref":"#/components/schemas/DiscoveryAddStores"}},"additionalProperties":false}},"required":["campaignId","expectedSettingsRevision","reviewedEstimate","changes"],"additionalProperties":false,"deprecated":true},"DiscoveryCampaignSettingsUpdateResponse":{"type":"object","properties":{"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"changed":{"type":"boolean","description":"False when the Save asked for the settings the campaign has."},"settingsRevision":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The campaign's revision now."},"changes":{"$ref":"#/components/schemas/DiscoveryChanges2"}},"required":["campaignId","changed","settingsRevision","changes"],"additionalProperties":false},"DiscoveryCampaignSettingsUpdateV2Request":{"type":"object","properties":{"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The campaign's id."},"expectedSettingsRevision":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The settingsRevision the settings read (or a quote) returned."},"reviewedEstimate":{"anyOf":[{"type":"object","properties":{"monthlyAfter":{"type":"integer","minimum":0,"maximum":9007199254740991},"unitPriceCents":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"oneTimeAmountCents":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]}},"required":["monthlyAfter","unitPriceCents","oneTimeAmountCents"],"additionalProperties":false,"description":"The estimate a quote returned (its reviewedEstimate): the Save is refused if it moved. Null saves at the current estimate."},{"type":"null"}]},"changes":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120,"description":"The campaign's new name."},"engines":{"description":"The assistants the campaign asks from its next run: the whole set, at least one. Add, remove or swap; past conversations stay.","minItems":1,"maxItems":4,"type":"array","items":{"type":"string","enum":["chatgpt","gemini","claude","grok"]}},"engineCatchUp":{"description":"When an assistant is added: also run it once, within a day, for the customers this month's runs already refreshed (true when omitted), so its results are complete this month.","type":"boolean"},"customerCount":{"description":"How many customers it runs: the campaign's total, or, on a store campaign, the customers per store. Raising it adds eligible customers, then generates the rest; lowering it removes the newest joined first unless removeCustomerIds names who leaves.","type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"addCustomerIds":{"description":"Customers to add; each joins this month's calendar.","maxItems":1000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"removeCustomerIds":{"description":"Customers to remove; each leaves every later run at once and keeps its history.","maxItems":1000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"removeStoreKeys":{"description":"Stores to stop measuring, by key: their customers leave at once and their history stays.","maxItems":309,"type":"array","items":{"type":"string","minLength":1,"maxLength":2000}},"addStores":{"$ref":"#/components/schemas/DiscoveryAddStores"}},"additionalProperties":false}},"required":["campaignId","expectedSettingsRevision","reviewedEstimate","changes"],"additionalProperties":false},"DiscoveryCampaignSettingsUpdateV2Response":{"type":"object","properties":{"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"changed":{"type":"boolean","description":"False when the Save asked for the settings the campaign has."},"settingsRevision":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The campaign's revision now."},"changes":{"$ref":"#/components/schemas/DiscoveryChanges2"}},"required":["campaignId","changed","settingsRevision","changes"],"additionalProperties":false},"DiscoveryPrecisionQuotesGetResponse":{"type":"object","properties":{"control":{"type":"object","properties":{"available":{"type":"boolean"},"reason":{"type":"string","enum":["ok","operator_run","published_pilot","setup_pending","paused","profile_pending","hand_picked","too_many_audiences","not_current_mode","location_campaign","runs_once","viewer_role","not_active"],"description":"Why the control reads as it does; `ok` when the customer may change it."},"title":{"type":"string"},"detail":{"type":"string"},"action":{"description":"The one next step a refusal offers, when the reader has one.","type":"object","properties":{"label":{"type":"string"},"href":{"type":"string"}},"required":["label","href"],"additionalProperties":false}},"required":["available","reason","title","detail"],"additionalProperties":false,"description":"The campaign's precision control verdict."},"quote":{"type":"object","properties":{"productSlug":{"type":"string","const":"discovery"},"dimensionKey":{"type":"string","const":"interaction"},"unitPriceCents":{"type":"integer","minimum":0,"maximum":100000000},"quantity":{"type":"integer","minimum":1,"maximum":1000000},"totalCents":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["productSlug","dimensionKey","unitPriceCents","quantity","totalCents"],"additionalProperties":false,"description":"The price of one Discovery conversation (quantity 1)."},"campaign":{"type":"object","properties":{"unitPriceCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Price of one Discovery conversation: one twin, one assistant, one refresh."},"campaignCustomerCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The panel the order grows."},"engineCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Assistants each added twin is measured on."},"laneCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Cohort lanes each added twin is refreshed in."},"locationCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The stores a location campaign measures now; a higher customer count is per store, so it grows in whole stores. 0 for a brand-wide campaign."},"customerGenerationUnitPriceCents":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Always 0: the customers an order generates are included in the plan and charge nothing."},"maxAddedCustomers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The most customers one order may add to this campaign, by the limits of the door that commits it: for the customer's own campaign, the most customers a campaign runs and the most one order generates; for a published pilot's own campaign, the most its whole panel holds."}},"required":["unitPriceCents","campaignCustomerCount","engineCount","laneCount","locationCount","customerGenerationUnitPriceCents","maxAddedCustomers"],"additionalProperties":false,"description":"The panel and multipliers an added customer is measured against."}},"required":["control","quote","campaign"],"additionalProperties":false},"DiscoveryPrecisionIncreasesListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"orderId":{"type":"string","description":"The order's run id."},"focus":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"profile_mix"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"base_bucket"},"dimensionId":{"type":"string","enum":["audience_mix","channel_mix","revenue_mix"]},"bucketId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"label":{"type":"string","minLength":1,"maxLength":160}},"required":["kind","dimensionId","bucketId","label"],"additionalProperties":false}],"description":"The generation focus the order was placed with."},"targetCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Customers the order generates and adds."},"orderedCustomerCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The campaign's panel once they join, as the order saw it."},"rungLabel":{"type":"string"},"generatedCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Customers the order's Customer run published."},"addedCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Of those, the ones on the campaign's roster now."},"interviewedCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Of those, the ones with a completed interview extraction."},"startedAt":{"type":"string","description":"ISO timestamp."},"state":{"type":"string","enum":["generating","interviewing","done","failed"],"description":"`generating` while customers are made, `interviewing` while they join and are interviewed, `done` once every added customer's interview ended, `failed` when a run failed or an owner refused it."},"rungMarginOfErrorPct":{"type":"number"}},"required":["orderId","focus","targetCount","orderedCustomerCount","rungLabel","generatedCount","addedCount","interviewedCount","startedAt","state","rungMarginOfErrorPct"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"precisionControl":{"$ref":"#/components/schemas/DiscoveryPrecisionControl"}},"required":["data","nextCursor","precisionControl"],"additionalProperties":false},"DiscoveryPrecisionIncreasesListV2Response":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"orderId":{"type":"string","description":"The order's run id."},"focus":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"profile_mix"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"base_bucket"},"dimensionId":{"type":"string","enum":["audience_mix","channel_mix","revenue_mix"]},"bucketId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"label":{"type":"string","minLength":1,"maxLength":160}},"required":["kind","dimensionId","bucketId","label"],"additionalProperties":false}],"description":"The generation focus the order was placed with."},"targetCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Customers the order generates and adds."},"orderedCustomerCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The campaign's panel once they join, as the order saw it."},"rungLabel":{"type":"string"},"generatedCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Customers the order's Customer run published."},"addedCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Of those, the ones on the campaign's roster now."},"interviewedCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Of those, the ones with a completed interview extraction."},"startedAt":{"type":"string","description":"ISO timestamp."},"state":{"type":"string","enum":["generating","interviewing","done","failed"],"description":"`generating` while customers are made, `interviewing` while they join and are interviewed, `done` once every added customer's interview ended, `failed` when a run failed or an owner refused it."}},"required":["orderId","focus","targetCount","orderedCustomerCount","rungLabel","generatedCount","addedCount","interviewedCount","startedAt","state"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"precisionControl":{"$ref":"#/components/schemas/DiscoveryPrecisionControl"}},"required":["data","nextCursor","precisionControl"],"additionalProperties":false},"DiscoveryCoverageQuotesGetResponse":{"type":"object","properties":{"control":{"type":"object","properties":{"available":{"type":"boolean"},"reason":{"type":"string","enum":["ok","operator_run","published_pilot","setup_pending","paused","profile_pending","hand_picked","too_many_audiences","not_current_mode","location_campaign","runs_once","viewer_role","not_active"],"description":"Why the control reads as it does; `ok` when the customer may change it."},"title":{"type":"string"},"detail":{"type":"string"},"action":{"description":"The one next step a refusal offers, when the reader has one.","type":"object","properties":{"label":{"type":"string"},"href":{"type":"string"}},"required":["label","href"],"additionalProperties":false}},"required":["available","reason","title","detail"],"additionalProperties":false,"description":"The campaign's coverage control verdict."},"quote":{"type":"object","properties":{"productSlug":{"type":"string","const":"discovery"},"dimensionKey":{"type":"string","const":"interaction"},"unitPriceCents":{"type":"integer","minimum":0,"maximum":100000000},"quantity":{"type":"integer","minimum":1,"maximum":1000000},"totalCents":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["productSlug","dimensionKey","unitPriceCents","quantity","totalCents"],"additionalProperties":false,"description":"The price of one Discovery conversation (quantity 1)."},"campaign":{"type":"object","properties":{"unitPriceCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Price of one Discovery conversation."},"interactionLabel":{"type":"object","properties":{"singular":{"type":"string"},"plural":{"type":"string"}},"required":["singular","plural"],"additionalProperties":false,"description":"The conversation's own word."},"twinCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Twins the campaign refreshes."},"selectedEngines":{"type":"array","items":{"type":"string","enum":["chatgpt","gemini","claude","grok"]},"description":"Assistants measured today."},"addableEngines":{"type":"array","items":{"type":"string","enum":["chatgpt","gemini","claude","grok"]},"description":"Assistants this order could add."},"engineEstimate":{"type":"object","properties":{"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Conversations added each month."},"unitPriceCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"amountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"count × unitPriceCents, at today's price."}},"required":["count","unitPriceCents","amountCents"],"additionalProperties":false,"description":"One added assistant."}},"required":["unitPriceCents","interactionLabel","twinCount","selectedEngines","addableEngines","engineEstimate"],"additionalProperties":false}},"required":["control","quote","campaign"],"additionalProperties":false},"DiscoveryLocationQuotesGetResponse":{"type":"object","properties":{"quote":{"type":"object","properties":{"locationCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The stores the campaign measures now, never one its settings removed."},"maxLocationCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The most locations one campaign holds."},"addedLocationCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"customersPerLocation":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Customers each location samples."},"addedCustomerCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Customers the added locations sample."},"estimate":{"type":"object","properties":{"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Conversations added each month."},"unitPriceCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"amountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"count × unitPriceCents, at today's price."}},"required":["count","unitPriceCents","amountCents"],"additionalProperties":false,"description":"Conversations the added customers add each month, at today's price."}},"required":["locationCount","maxLocationCount","addedLocationCount","customersPerLocation","addedCustomerCount","estimate"],"additionalProperties":false}},"required":["quote"],"additionalProperties":false},"DiscoveryBrandMatchupsGetResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"kind":{"type":"string","const":"detail"},"datasetKey":{"type":"string"},"brandAKey":{"type":"string"},"brandBKey":{"type":"string"},"brandAWins":{"type":"number"},"brandBWins":{"type":"number"},"total":{"type":"number"},"brandAWinRate":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"0..1; null when no matchup was decided."},"decisiveness":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Average recommendation-strength margin per decided matchup (0..4)."},"evidence":{"type":"object","properties":{"status":{"type":"string","enum":["none","sparse","supported","confident"]},"label":{"type":"string","enum":["No evidence","Low evidence","Supported evidence","High confidence"]},"decidedMatchups":{"type":"number"},"confident":{"type":"boolean"},"wilsonLowerBound":{"type":"number","description":"Wilson 95% lower bound of the leader's win share."}},"required":["status","label","decidedMatchups","confident","wilsonLowerBound"],"additionalProperties":false},"loserReasons":{"type":"array","items":{"type":"object","properties":{"brandKey":{"type":"string"},"reasons":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"count":{"type":"number"}},"required":["label","count"],"additionalProperties":false}}},"required":["brandKey","reasons"],"additionalProperties":false}},"availableDimensions":{"type":"array","items":{"type":"string","enum":["decision-factors","audiences","engines"],"description":"The dimension a matchup splits by."}}},"required":["kind","datasetKey","brandAKey","brandBKey","brandAWins","brandBWins","total","brandAWinRate","decisiveness","evidence","loserReasons","availableDimensions"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"DiscoveryBrandMatchupsGetV2Response":{"type":"object","properties":{"data":{"type":"object","properties":{"kind":{"type":"string","const":"detail"},"datasetKey":{"type":"string"},"brandAKey":{"type":"string"},"brandBKey":{"type":"string"},"brandAWins":{"type":"number"},"brandBWins":{"type":"number"},"total":{"type":"number"},"brandAWinRate":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"0..1; null when no matchup was decided."},"decisiveness":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Average recommendation-strength margin per decided matchup (0..4)."},"evidence":{"type":"object","properties":{"decidedMatchups":{"type":"number","description":"The pair's decided matchups."}},"required":["decidedMatchups"],"additionalProperties":false},"loserReasons":{"type":"array","items":{"type":"object","properties":{"brandKey":{"type":"string"},"reasons":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"count":{"type":"number"}},"required":["label","count"],"additionalProperties":false}}},"required":["brandKey","reasons"],"additionalProperties":false}},"availableDimensions":{"type":"array","items":{"type":"string","enum":["decision-factors","audiences","engines"],"description":"The dimension a matchup splits by."}}},"required":["kind","datasetKey","brandAKey","brandBKey","brandAWins","brandBWins","total","brandAWinRate","decisiveness","evidence","loserReasons","availableDimensions"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"DiscoveryBrandMatchupBreakdownsGetResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"kind":{"type":"string","const":"breakdown"},"datasetKey":{"type":"string"},"dimension":{"type":"string","enum":["decision-factors","audiences","engines"],"description":"The dimension a matchup splits by."},"rows":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"label":{"type":"string"},"brandAWins":{"type":"number"},"brandBWins":{"type":"number"},"total":{"type":"number"},"brandAWinRate":{"type":"number"},"deltaFromOverall":{"type":"number"},"evidence":{"type":"object","properties":{"status":{"type":"string","enum":["none","sparse","supported","confident"]},"label":{"type":"string","enum":["No evidence","Low evidence","Supported evidence","High confidence"]},"decidedMatchups":{"type":"number"},"confident":{"type":"boolean"},"wilsonLowerBound":{"type":"number","description":"Wilson 95% lower bound of the leader's win share."}},"required":["status","label","decidedMatchups","confident","wilsonLowerBound"],"additionalProperties":false}},"required":["value","label","brandAWins","brandBWins","total","brandAWinRate","deltaFromOverall","evidence"],"additionalProperties":false}},"suppressedValueCount":{"type":"number","description":"Members left out for too little evidence to split on."}},"required":["kind","datasetKey","dimension","rows","suppressedValueCount"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"DiscoveryBrandMatchupBreakdownsGetV2Response":{"type":"object","properties":{"data":{"type":"object","properties":{"kind":{"type":"string","const":"breakdown"},"datasetKey":{"type":"string"},"dimension":{"type":"string","enum":["decision-factors","audiences","engines"],"description":"The dimension a matchup splits by."},"rows":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"label":{"type":"string"},"brandAWins":{"type":"number"},"brandBWins":{"type":"number"},"total":{"type":"number"},"brandAWinRate":{"type":"number"},"deltaFromOverall":{"type":"number"},"evidence":{"type":"object","properties":{"decidedMatchups":{"type":"number","description":"The pair's decided matchups."}},"required":["decidedMatchups"],"additionalProperties":false}},"required":["value","label","brandAWins","brandBWins","total","brandAWinRate","deltaFromOverall","evidence"],"additionalProperties":false}},"suppressedValueCount":{"type":"number","description":"Values with a decided matchup beyond the ones listed."}},"required":["kind","datasetKey","dimension","rows","suppressedValueCount"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"DiscoveryBrandCohortsGetResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"kind":{"type":"string","const":"cohort"},"datasetKey":{"type":"string"},"cohort":{"type":"object","properties":{"dimension":{"type":"string","enum":["decision-factors","audiences","engines"],"description":"The dimension a matchup splits by."},"value":{"type":"string"},"label":{"type":"string"}},"required":["dimension","value","label"],"additionalProperties":false},"ladder":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"rank":{"type":"number","description":"1-based circle position by graded head-to-head strength."}},"required":["key","rank"],"additionalProperties":false}},"edges":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string","description":"The matchup's overall winner."},"target":{"type":"string"},"wins":{"type":"number"},"losses":{"type":"number"},"total":{"type":"number"},"confident":{"type":"boolean","description":"The Wilson 95% lower bound of the winner's share exceeds 50%."}},"required":["source","target","wins","losses","total","confident"],"additionalProperties":false}}},"required":["kind","datasetKey","cohort","ladder","edges"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"DiscoveryBrandCohortsGetV2Response":{"type":"object","properties":{"data":{"type":"object","properties":{"kind":{"type":"string","const":"cohort"},"datasetKey":{"type":"string"},"cohort":{"type":"object","properties":{"dimension":{"type":"string","enum":["decision-factors","audiences","engines"],"description":"The dimension a matchup splits by."},"value":{"type":"string"},"label":{"type":"string"}},"required":["dimension","value","label"],"additionalProperties":false},"ladder":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"rank":{"type":"number","description":"1-based circle position by graded head-to-head strength."}},"required":["key","rank"],"additionalProperties":false}},"edges":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string","description":"The matchup's overall winner."},"target":{"type":"string"},"wins":{"type":"number"},"losses":{"type":"number"},"total":{"type":"number"}},"required":["source","target","wins","losses","total"],"additionalProperties":false}}},"required":["kind","datasetKey","cohort","ladder","edges"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"DiscoveryCompetitorReasonsGetResponse":{"type":"object","properties":{"data":{"anyOf":[{"type":"object","properties":{"option":{"$ref":"#/components/schemas/DiscoveryOption"},"winDrivers":{"type":"array","items":{"$ref":"#/components/schemas/DiscoveryWinDriversItem"},"description":"Why the campaign's brand wins against it."},"lossDrivers":{"type":"array","items":{"$ref":"#/components/schemas/DiscoveryWinDriversItem"},"description":"Why the campaign's brand loses to it."},"lineage":{"type":"object","properties":{"win":{"anyOf":[{"type":"object","properties":{"metricId":{"type":"string"},"tables":{"readOnly":true,"type":"array","items":{"type":"string"}},"pipelineStage":{"anyOf":[{"type":"number"},{"type":"null"}]},"campaignId":{"type":"string"},"dispatchId":{"type":"string"}},"required":["metricId","tables","pipelineStage","campaignId","dispatchId"],"additionalProperties":false},{"type":"null"}]},"loss":{"anyOf":[{"type":"object","properties":{"metricId":{"type":"string"},"tables":{"readOnly":true,"type":"array","items":{"type":"string"}},"pipelineStage":{"anyOf":[{"type":"number"},{"type":"null"}]},"campaignId":{"type":"string"},"dispatchId":{"type":"string"}},"required":["metricId","tables","pipelineStage","campaignId","dispatchId"],"additionalProperties":false},{"type":"null"}]}},"required":["win","loss"],"additionalProperties":false,"description":"Always null: an on-demand read carries no lineage."},"conversationCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The as-of window's conversations these reasons are counted from: those naming both brands where one of the two is the brand the conversation recommended. For the campaign's own brand, the conversations discovery.conversations.list.v2 lists with `rival` set to `option.id`."}},"required":["option","winDrivers","lossDrivers","lineage","conversationCount"],"additionalProperties":false},{"type":"null"}],"description":"Null when the Competitors read holds no entry for that brand."}},"required":["data"],"additionalProperties":false},"DiscoveryCompetitorReasonsGetV2Response":{"type":"object","properties":{"data":{"anyOf":[{"type":"object","properties":{"option":{"$ref":"#/components/schemas/DiscoveryOption"},"winDrivers":{"$ref":"#/components/schemas/DiscoveryWinDrivers"},"lossDrivers":{"$ref":"#/components/schemas/DiscoveryLossDrivers"},"lineage":{"$ref":"#/components/schemas/DiscoveryLineage"},"conversationCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The as-of window's conversations these reasons are counted from: those naming both brands where one of the two is the brand the conversation recommended. For the campaign's own brand, the conversations discovery.conversations.list.v2 lists with `rival` set to `option.id`."}},"required":["option","winDrivers","lossDrivers","lineage","conversationCount"],"additionalProperties":false},{"type":"null"}],"description":"Null when the Competitors read holds no entry for that brand."}},"required":["data"],"additionalProperties":false},"DiscoveryCompetitorReasonsGetV3Response":{"type":"object","properties":{"data":{"anyOf":[{"type":"object","properties":{"option":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"label":{"type":"string"},"color":{"type":"string"},"dataCount":{"type":"number"},"leadingIcon":{"type":"object","properties":{"src":{"anyOf":[{"type":"string"},{"type":"null"}]},"fallbackLabel":{"type":"string"},"fallbackSeed":{"anyOf":[{"type":"string"},{"type":"null"}]},"tone":{"anyOf":[{"type":"string","enum":["dark","light","mixed","unknown"]},{"type":"null"}]},"transparent":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"needsLightBackplate":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"needsDarkBackplate":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"brandColor":{"description":"The brand's assigned color when the row is a campaign brand.","anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["src","fallbackLabel"],"additionalProperties":false},"depth":{"type":"number"}},"required":["id","name","color"],"additionalProperties":false},"winDrivers":{"$ref":"#/components/schemas/DiscoveryWinDrivers"},"lossDrivers":{"$ref":"#/components/schemas/DiscoveryLossDrivers"},"lineage":{"$ref":"#/components/schemas/DiscoveryLineage"},"conversationCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The as-of window's conversations these reasons are counted from: those naming both brands where one of the two is the brand the conversation recommended. For the campaign's own brand, the conversations discovery.conversations.list.v2 lists with `rival` set to `option.id`."}},"required":["option","winDrivers","lossDrivers","lineage","conversationCount"],"additionalProperties":false},{"type":"null"}],"description":"Null when the Competitors read holds no entry for that brand."}},"required":["data"],"additionalProperties":false},"DiscoverySegmentOptionsGetV3Response":{"type":"object","properties":{"axes":{"type":"array","items":{"type":"object","properties":{"axis":{"type":"string","enum":["audience","channel","market","age","householdIncome","education","lifeStage","areaType","companySize","buyerRole","seniority","occupation","job","triggerType","intentStage","language","gender","product","engine","competitor","topic","sentiment","store","customer"]},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The member's id, as a segment filter names it."},"label":{"type":"string","description":"The member's name in the campaign's data."}},"required":["id","label"],"additionalProperties":false}}},"required":["axis","options"],"additionalProperties":false}}},"required":["axes"],"additionalProperties":false},"DiscoveryOverviewReportsGetV4Response":{"type":"object","properties":{"scope":{"$ref":"#/components/schemas/DiscoveryScope"},"report":{"anyOf":[{"type":"object","properties":{"kpis":{"$ref":"#/components/schemas/DiscoveryKpis"},"competitivePosition":{"type":"object","properties":{"customerCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct customers of the as-of window's conversations: every row's share and win rate stand on them."},"earlierCustomerCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct customers of the conversations in the window 30 days before, which every row's movement compares with."},"competitivePosition":{"type":"array","items":{"type":"object","properties":{"faviconUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"faviconLightUrl":{"default":null,"description":"Always null: a source's favicon is one image for both themes, faviconUrl.","type":"null"},"faviconDarkUrl":{"default":null,"description":"Always null: a source's favicon is one image for both themes, faviconUrl.","type":"null"},"faviconFallbackLabel":{"type":"string"},"faviconTone":{"type":"string","enum":["dark","light","mixed","unknown"]},"faviconTransparent":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"faviconNeedsLightBackplate":{"type":"boolean"},"faviconNeedsDarkBackplate":{"type":"boolean"},"brandColor":{"description":"The campaign's assigned color token for this brand.","anyOf":[{"type":"string"},{"type":"null"}]},"id":{"type":"string"},"name":{"type":"string"},"isCurrent":{"type":"boolean","description":"The brand the results are read as."},"brandShare":{"type":"number"},"brandWinRate":{"type":"number"},"movement":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Its brand share minus its brand share 30 days before the as-of day; null when that window holds no conversation in scope."}},"required":["faviconUrl","faviconLightUrl","faviconDarkUrl","faviconFallbackLabel","faviconTone","faviconTransparent","faviconNeedsLightBackplate","faviconNeedsDarkBackplate","id","name","isCurrent","brandShare","brandWinRate","movement"],"additionalProperties":false},"description":"The target, then the brands the model labelled competitor or hybrid."},"competitivePositionTotalCount":{"type":"number"},"optionClasses":{"$ref":"#/components/schemas/DiscoveryOptionClasses"},"decisions":{"type":"object","properties":{"total":{"type":"number","description":"Conversations whose assistant picked a winner."},"unownedOffering":{"type":"number"},"approach":{"type":"number"}},"required":["total","unownedOffering","approach"],"additionalProperties":false}},"required":["customerCount","earlierCustomerCount","competitivePosition","competitivePositionTotalCount","optionClasses","decisions"],"additionalProperties":false},"winLoss":{"type":"object","properties":{"segments":{"readOnly":true,"description":"The segments the reads were narrowed to.","type":"array","items":{"type":"object","properties":{"axis":{"type":"string","enum":["audience","channel","market","age","householdIncome","education","lifeStage","areaType","companySize","buyerRole","seniority","occupation","job","triggerType","intentStage","language","gender","product","engine","competitor","topic","sentiment","store","customer"],"description":"A pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or one `store` or `customer`."},"id":{"type":"string","minLength":1,"maxLength":300,"description":"The member's id on that axis, as `discovery.segment-options.get` lists it."}},"required":["axis","id"],"additionalProperties":false}},"driverComparisons":{"description":"Win/loss reasons against each leading competitor.","type":"array","items":{"type":"object","properties":{"faviconUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"faviconLightUrl":{"default":null,"description":"Always null: a source's favicon is one image for both themes, faviconUrl.","type":"null"},"faviconDarkUrl":{"default":null,"description":"Always null: a source's favicon is one image for both themes, faviconUrl.","type":"null"},"faviconFallbackLabel":{"type":"string"},"faviconTone":{"type":"string","enum":["dark","light","mixed","unknown"]},"faviconTransparent":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"faviconNeedsLightBackplate":{"type":"boolean"},"faviconNeedsDarkBackplate":{"type":"boolean"},"brandColor":{"description":"The campaign's assigned color token for this brand.","anyOf":[{"type":"string"},{"type":"null"}]},"id":{"type":"string"},"name":{"type":"string"},"whyWeWin":{"$ref":"#/components/schemas/DiscoveryWhyWeWin"},"whyWeLose":{"$ref":"#/components/schemas/DiscoveryWhyWeWin"}},"required":["faviconUrl","faviconLightUrl","faviconDarkUrl","faviconFallbackLabel","faviconTone","faviconTransparent","faviconNeedsLightBackplate","faviconNeedsDarkBackplate","id","name","whyWeWin","whyWeLose"],"additionalProperties":false}},"driverComparisonTotalCount":{"type":"number"},"whyWeWin":{"$ref":"#/components/schemas/DiscoveryWhyWeWin"},"whyWeWinTotalCount":{"type":"number"},"whyWeLose":{"$ref":"#/components/schemas/DiscoveryWhyWeWin"},"whyWeLoseTotalCount":{"type":"number"},"insightsGenerated":{"type":"boolean","description":"Whether the as-of window holds a conversation in scope."}},"required":["segments","driverComparisonTotalCount","whyWeWin","whyWeWinTotalCount","whyWeLose","whyWeLoseTotalCount","insightsGenerated"],"additionalProperties":false},"conversations":{"type":"object","properties":{"totalConversations":{"type":"number"}},"required":["totalConversations"],"additionalProperties":false}},"required":["kpis","competitivePosition","winLoss","conversations"],"additionalProperties":false},{"type":"null"}],"description":"Null unless `scope.state` is `ready`."}},"required":["scope","report"],"additionalProperties":false},"DiscoveryOverviewReportsGetV5Response":{"type":"object","properties":{"scope":{"$ref":"#/components/schemas/DiscoveryScope"},"report":{"anyOf":[{"type":"object","properties":{"kpis":{"$ref":"#/components/schemas/DiscoveryKpis"},"competitivePosition":{"type":"object","properties":{"customerCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct customers of the as-of window's conversations: every row's share and win rate stand on them."},"earlierCustomerCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct customers of the conversations in the window 30 days before, which every row's movement compares with."},"competitivePosition":{"type":"array","items":{"type":"object","properties":{"faviconUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"faviconFallbackLabel":{"type":"string"},"faviconTone":{"type":"string","enum":["dark","light","mixed","unknown"]},"faviconTransparent":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"faviconNeedsLightBackplate":{"type":"boolean"},"faviconNeedsDarkBackplate":{"type":"boolean"},"brandColor":{"description":"The campaign's assigned color token for this brand.","anyOf":[{"type":"string"},{"type":"null"}]},"id":{"type":"string"},"name":{"type":"string"},"isCurrent":{"type":"boolean","description":"The brand the results are read as."},"brandShare":{"type":"number"},"brandWinRate":{"type":"number"},"movement":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Its brand share minus its brand share 30 days before the as-of day; null when that window holds no conversation in scope."}},"required":["faviconUrl","faviconFallbackLabel","faviconTone","faviconTransparent","faviconNeedsLightBackplate","faviconNeedsDarkBackplate","id","name","isCurrent","brandShare","brandWinRate","movement"],"additionalProperties":false},"description":"The target, then the brands the model labelled competitor or hybrid."},"competitivePositionTotalCount":{"type":"number"},"optionClasses":{"$ref":"#/components/schemas/DiscoveryOptionClasses"},"decisions":{"type":"object","properties":{"total":{"type":"number","description":"Conversations whose assistant picked a winner."},"unownedOffering":{"type":"number"},"approach":{"type":"number"}},"required":["total","unownedOffering","approach"],"additionalProperties":false}},"required":["customerCount","earlierCustomerCount","competitivePosition","competitivePositionTotalCount","optionClasses","decisions"],"additionalProperties":false},"winLoss":{"type":"object","properties":{"segments":{"readOnly":true,"description":"The segments the reads were narrowed to.","type":"array","items":{"type":"object","properties":{"axis":{"type":"string","enum":["audience","channel","market","age","householdIncome","education","lifeStage","areaType","companySize","buyerRole","seniority","occupation","job","triggerType","intentStage","language","gender","product","engine","competitor","topic","sentiment","store","customer"],"description":"A pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or one `store` or `customer`."},"id":{"type":"string","minLength":1,"maxLength":300,"description":"The member's id on that axis, as `discovery.segment-options.get` lists it."}},"required":["axis","id"],"additionalProperties":false}},"driverComparisons":{"description":"Win/loss reasons against each leading competitor.","type":"array","items":{"type":"object","properties":{"faviconUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"faviconFallbackLabel":{"type":"string"},"faviconTone":{"type":"string","enum":["dark","light","mixed","unknown"]},"faviconTransparent":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"faviconNeedsLightBackplate":{"type":"boolean"},"faviconNeedsDarkBackplate":{"type":"boolean"},"brandColor":{"description":"The campaign's assigned color token for this brand.","anyOf":[{"type":"string"},{"type":"null"}]},"id":{"type":"string"},"name":{"type":"string"},"whyWeWin":{"$ref":"#/components/schemas/DiscoveryWhyWeWin"},"whyWeLose":{"$ref":"#/components/schemas/DiscoveryWhyWeWin"}},"required":["faviconUrl","faviconFallbackLabel","faviconTone","faviconTransparent","faviconNeedsLightBackplate","faviconNeedsDarkBackplate","id","name","whyWeWin","whyWeLose"],"additionalProperties":false}},"driverComparisonTotalCount":{"type":"number"},"whyWeWin":{"$ref":"#/components/schemas/DiscoveryWhyWeWin"},"whyWeWinTotalCount":{"type":"number"},"whyWeLose":{"$ref":"#/components/schemas/DiscoveryWhyWeWin"},"whyWeLoseTotalCount":{"type":"number"},"insightsGenerated":{"type":"boolean","description":"Whether the as-of window holds a conversation in scope."}},"required":["segments","driverComparisonTotalCount","whyWeWin","whyWeWinTotalCount","whyWeLose","whyWeLoseTotalCount","insightsGenerated"],"additionalProperties":false},"conversations":{"type":"object","properties":{"totalConversations":{"type":"number"}},"required":["totalConversations"],"additionalProperties":false}},"required":["kpis","competitivePosition","winLoss","conversations"],"additionalProperties":false},{"type":"null"}],"description":"Null unless `scope.state` is `ready`."}},"required":["scope","report"],"additionalProperties":false},"DiscoveryRevenueReportsGetV4Response":{"type":"object","properties":{"scope":{"$ref":"#/components/schemas/DiscoveryScope"},"report":{"anyOf":[{"type":"object","properties":{"brandScopes":{"$ref":"#/components/schemas/DiscoveryBrandScopes"},"segmentCountSeries":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"UTC day; the value is its trailing 30-day window's."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Null where that window holds no interaction."}},"required":["day","value"],"additionalProperties":false},"description":"Segments with a conversation in each day's window; null where it holds no conversation in scope."},"segmentCountDelta":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The segment count minus its count 30 days before the as-of day; null when that window holds no conversation in scope."},"conversationCount":{"type":"number","description":"The as-of window's conversations, narrowed like every other figure."},"revenueCoverage":{"type":"object","properties":{"scope":{"description":"Location estimates may overlap markets.","type":"string","const":"locations"},"status":{"type":"string","enum":["none","partial","complete"]},"includedLineCount":{"type":"number"},"totalLineCount":{"type":"number"},"coveredConversationCount":{"type":"number"},"totalConversationCount":{"type":"number"},"coveragePct":{"type":"number"}},"required":["status","includedLineCount","totalLineCount","coveredConversationCount","totalConversationCount","coveragePct"],"additionalProperties":false},"segments":{"type":"array","items":{"type":"object","properties":{"axis":{"type":"string","enum":["audience","channel","market","age","householdIncome","education","lifeStage","areaType","companySize","buyerRole","seniority","occupation","job","triggerType","intentStage","language","gender","product","engine","competitor","topic","sentiment","store","customer"],"description":"A pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or one `store` or `customer`."},"id":{"type":"string","minLength":1,"maxLength":300,"description":"The member's id on that axis, as `discovery.segment-options.get` lists it."}},"required":["axis","id"],"additionalProperties":false},"description":"The segments every figure was narrowed to, ANDed; empty is the whole campaign."},"breaks":{"description":"Days in the trends' span the campaign's conversations changed behavior version (its opening questions, customer replies or interview schedule), each with what changed; absent with none.","type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"label":{"type":"string"}},"required":["day","label"],"additionalProperties":false}},"lines":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"color":{"type":"string"},"vsPortfolioPts":{"type":"number","description":"The line's brand win rate minus the campaign's all-up win rate, in points."},"topCompetitor":{"anyOf":[{"type":"string"},{"type":"null"}]},"isLeader":{"type":"boolean"},"parentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"level":{"type":"number","enum":[1,2,3]},"childIds":{"type":"array","items":{"type":"string"}},"brandShare":{"type":"number","description":"Brand share (%)."},"brandShareDelta":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The value minus its value 30 days before the window's as-of day; null when that window holds none of the segment's conversations."},"winRate":{"type":"number","description":"Brand win rate (%)."},"winRateDelta":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The value minus its value 30 days before the window's as-of day; null when that window holds none of the segment's conversations."},"customers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct customers of the segment's as-of window conversations: the sample its share and win rate stand on."},"earlierCustomers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct customers of the segment's conversations in the window 30 days before, which its changes compare with; 0 when that window holds none."},"revenueInfluencedUsd":{"description":"Target revenue influenced over the as-of window; null where no market assumption prices the line, absent under a competitor lens.","anyOf":[{"type":"number"},{"type":"null"}]},"revenueInfluenceableUsd":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["id","name","color","vsPortfolioPts","brandShare","brandShareDelta","winRate","winRateDelta","customers","earlierCustomers"],"additionalProperties":false}},"drivers":{"type":"array","items":{"type":"object","properties":{"lineId":{"type":"string"},"kind":{"type":"string","enum":["win","loss"]},"label":{"type":"string","description":"The reason, as the model wrote it."},"count":{"type":"number","description":"Conversations of the as-of window citing the reason."},"customers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct customers of the as-of window's conversations its kind counts from (wins for a win reason, losses for a loss reason): the sample its count stands on."},"series":{"description":"Its count in each day's window; null where the window holds none of its segment's conversations.","type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"UTC day; the value is its trailing 30-day window's."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Null where that window holds no interaction."}},"required":["day","value"],"additionalProperties":false}}},"required":["lineId","kind","label","count","customers"],"additionalProperties":false}},"lineSeries":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/DiscoveryLineSeries"},"description":"Keyed by product (revenue line) id, as lines[].id."},"portfolioShare":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"measured"},"value":{"type":"number"}},"required":["kind","value"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"absent"},"reason":{"type":"string","enum":["no_measurement_in_scope","no_conversations_in_segment"],"description":"`no_conversations_in_segment`: the segments left no conversation of the window; `no_measurement_in_scope`: the window, unnarrowed, holds none the figure counts."}},"required":["kind","reason"],"additionalProperties":false}],"description":"The figure (`kind` measured, `value` in percent), or `kind` absent with the `reason` nothing in scope measured it: never a 0 for an empty denominator."},"portfolioWinRate":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"measured"},"value":{"type":"number"}},"required":["kind","value"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"absent"},"reason":{"type":"string","enum":["no_measurement_in_scope","no_conversations_in_segment"],"description":"`no_conversations_in_segment`: the segments left no conversation of the window; `no_measurement_in_scope`: the window, unnarrowed, holds none the figure counts."}},"required":["kind","reason"],"additionalProperties":false}],"description":"The figure (`kind` measured, `value` in percent), or `kind` absent with the `reason` nothing in scope measured it: never a 0 for an empty denominator."}},"required":["segmentCountSeries","segmentCountDelta","conversationCount","revenueCoverage","segments","lines","drivers","lineSeries","portfolioShare","portfolioWinRate"],"additionalProperties":false},{"type":"null"}],"description":"Null unless `scope.state` is `ready`."}},"required":["scope","report"],"additionalProperties":false},"DiscoveryAudienceReportsGetV4Response":{"type":"object","properties":{"scope":{"$ref":"#/components/schemas/DiscoveryScope"},"report":{"anyOf":[{"type":"object","properties":{"brandScopes":{"$ref":"#/components/schemas/DiscoveryBrandScopes"},"segmentCountSeries":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"UTC day; the value is its trailing 30-day window's."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Null where that window holds no interaction."}},"required":["day","value"],"additionalProperties":false},"description":"Segments with a conversation in each day's window; null where it holds no conversation in scope."},"segmentCountDelta":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The segment count minus its count 30 days before the as-of day; null when that window holds no conversation in scope."},"conversationCount":{"type":"number","description":"The as-of window's conversations, narrowed like every other figure."},"revenueCoverage":{"type":"object","properties":{"scope":{"description":"Location estimates may overlap markets.","type":"string","const":"locations"},"status":{"type":"string","enum":["none","partial","complete"]},"includedLineCount":{"type":"number"},"totalLineCount":{"type":"number"},"coveredConversationCount":{"type":"number"},"totalConversationCount":{"type":"number"},"coveragePct":{"type":"number"}},"required":["status","includedLineCount","totalLineCount","coveredConversationCount","totalConversationCount","coveragePct"],"additionalProperties":false},"segments":{"type":"array","items":{"type":"object","properties":{"axis":{"type":"string","enum":["audience","channel","market","age","householdIncome","education","lifeStage","areaType","companySize","buyerRole","seniority","occupation","job","triggerType","intentStage","language","gender","product","engine","competitor","topic","sentiment","store","customer"],"description":"A pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or one `store` or `customer`."},"id":{"type":"string","minLength":1,"maxLength":300,"description":"The member's id on that axis, as `discovery.segment-options.get` lists it."}},"required":["axis","id"],"additionalProperties":false},"description":"The segments every figure was narrowed to, ANDed; empty is the whole campaign."},"breaks":{"description":"Days in the trends' span the campaign's conversations changed behavior version (its opening questions, customer replies or interview schedule), each with what changed; absent with none.","type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"label":{"type":"string"}},"required":["day","label"],"additionalProperties":false}},"audiences":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"color":{"type":"string"},"vsPortfolioPts":{"type":"number","description":"Brand win rate minus the campaign's all-up brand win rate, in points."},"topCompetitor":{"anyOf":[{"type":"string"},{"type":"null"}]},"topTopic":{"type":"string"},"parentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"level":{"type":"number","enum":[1,2,3]},"childIds":{"type":"array","items":{"type":"string"}},"competitorDrilldown":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"audienceId":{"type":"string"},"name":{"type":"string"},"brandShare":{"type":"number"},"winRate":{"type":"number"},"vsPortfolioPts":{"type":"number","description":"Competitor win rate minus the campaign's all-up brand win rate, in points."},"mappedRelationshipCount":{"type":"number"},"relationshipTypes":{"type":"array","items":{"type":"string","enum":["target","competitor","partner","hybrid","influencer","adjacent","unrelated","unknown"]}}},"required":["id","audienceId","name","brandShare","winRate","vsPortfolioPts","mappedRelationshipCount"],"additionalProperties":false}},"brandShare":{"type":"number","description":"Brand share (%)."},"brandShareDelta":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The value minus its value 30 days before the window's as-of day; null when that window holds none of the segment's conversations."},"winRate":{"type":"number","description":"Brand win rate (%)."},"winRateDelta":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The value minus its value 30 days before the window's as-of day; null when that window holds none of the segment's conversations."},"customers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct customers of the segment's as-of window conversations: the sample its share and win rate stand on."},"earlierCustomers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct customers of the segment's conversations in the window 30 days before, which its changes compare with; 0 when that window holds none."},"revenueInfluencedUsd":{"description":"Target revenue influenced over the as-of window; absent under a competitor lens.","anyOf":[{"type":"number"},{"type":"null"}]},"revenueInfluenceableUsd":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["id","name","shortName","color","vsPortfolioPts","topTopic","brandShare","brandShareDelta","winRate","winRateDelta","customers","earlierCustomers"],"additionalProperties":false}},"drivers":{"$ref":"#/components/schemas/DiscoveryDrivers"},"strongestAudiences":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"description":{"type":"string"}},"required":["id","description"],"additionalProperties":false}},"losingGround":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"description":{"type":"string"}},"required":["id","description"],"additionalProperties":false}},"audienceSeries":{"$ref":"#/components/schemas/DiscoveryAudienceSeries"},"portfolioShare":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"measured"},"value":{"type":"number"}},"required":["kind","value"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"absent"},"reason":{"type":"string","enum":["no_measurement_in_scope","no_conversations_in_segment"],"description":"`no_conversations_in_segment`: the segments left no conversation of the window; `no_measurement_in_scope`: the window, unnarrowed, holds none the figure counts."}},"required":["kind","reason"],"additionalProperties":false}],"description":"The figure (`kind` measured, `value` in percent), or `kind` absent with the `reason` nothing in scope measured it: never a 0 for an empty denominator."},"portfolioWinRate":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"measured"},"value":{"type":"number"}},"required":["kind","value"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"absent"},"reason":{"type":"string","enum":["no_measurement_in_scope","no_conversations_in_segment"],"description":"`no_conversations_in_segment`: the segments left no conversation of the window; `no_measurement_in_scope`: the window, unnarrowed, holds none the figure counts."}},"required":["kind","reason"],"additionalProperties":false}],"description":"The figure (`kind` measured, `value` in percent), or `kind` absent with the `reason` nothing in scope measured it: never a 0 for an empty denominator."}},"required":["segmentCountSeries","segmentCountDelta","conversationCount","revenueCoverage","segments","audiences","drivers","strongestAudiences","losingGround","audienceSeries","portfolioShare","portfolioWinRate"],"additionalProperties":false},{"type":"null"}],"description":"Null unless `scope.state` is `ready`."}},"required":["scope","report"],"additionalProperties":false},"DiscoveryAudienceReportsGetV5Response":{"type":"object","properties":{"scope":{"$ref":"#/components/schemas/DiscoveryScope"},"report":{"anyOf":[{"type":"object","properties":{"brandScopes":{"$ref":"#/components/schemas/DiscoveryBrandScopes"},"segmentCountSeries":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"UTC day; the value is its trailing 30-day window's."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Null where that window holds no interaction."}},"required":["day","value"],"additionalProperties":false},"description":"Segments with a conversation in each day's window; null where it holds no conversation in scope."},"segmentCountDelta":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The segment count minus its count 30 days before the as-of day; null when that window holds no conversation in scope."},"conversationCount":{"type":"number","description":"The as-of window's conversations, narrowed like every other figure."},"revenueCoverage":{"type":"object","properties":{"scope":{"description":"Location estimates may overlap markets.","type":"string","const":"locations"},"status":{"type":"string","enum":["none","partial","complete"]},"includedLineCount":{"type":"number"},"totalLineCount":{"type":"number"},"coveredConversationCount":{"type":"number"},"totalConversationCount":{"type":"number"},"coveragePct":{"type":"number"}},"required":["status","includedLineCount","totalLineCount","coveredConversationCount","totalConversationCount","coveragePct"],"additionalProperties":false},"segments":{"type":"array","items":{"type":"object","properties":{"axis":{"type":"string","enum":["audience","channel","market","age","householdIncome","education","lifeStage","areaType","companySize","buyerRole","seniority","occupation","job","triggerType","intentStage","language","gender","product","engine","competitor","topic","sentiment","store","customer"],"description":"A pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or one `store` or `customer`."},"id":{"type":"string","minLength":1,"maxLength":300,"description":"The member's id on that axis, as `discovery.segment-options.get` lists it."}},"required":["axis","id"],"additionalProperties":false},"description":"The segments every figure was narrowed to, ANDed; empty is the whole campaign."},"breaks":{"description":"Days in the trends' span the campaign's conversations changed behavior version (its opening questions, customer replies or interview schedule), each with what changed; absent with none.","type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"label":{"type":"string"}},"required":["day","label"],"additionalProperties":false}},"audiences":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"color":{"type":"string"},"vsPortfolioPts":{"type":"number","description":"Brand win rate minus the campaign's all-up brand win rate, in points."},"topCompetitor":{"anyOf":[{"type":"string"},{"type":"null"}]},"parentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"level":{"type":"number","enum":[1,2,3]},"childIds":{"type":"array","items":{"type":"string"}},"competitorDrilldown":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"audienceId":{"type":"string"},"name":{"type":"string"},"brandShare":{"type":"number"},"winRate":{"type":"number"},"vsPortfolioPts":{"type":"number","description":"Competitor win rate minus the campaign's all-up brand win rate, in points."},"mappedRelationshipCount":{"type":"number"},"relationshipTypes":{"type":"array","items":{"type":"string","enum":["target","competitor","partner","hybrid","influencer","adjacent","unrelated","unknown"]}}},"required":["id","audienceId","name","brandShare","winRate","vsPortfolioPts","mappedRelationshipCount"],"additionalProperties":false}},"brandShare":{"type":"number","description":"Brand share (%)."},"brandShareDelta":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The value minus its value 30 days before the window's as-of day; null when that window holds none of the segment's conversations."},"winRate":{"type":"number","description":"Brand win rate (%)."},"winRateDelta":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The value minus its value 30 days before the window's as-of day; null when that window holds none of the segment's conversations."},"customers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct customers of the segment's as-of window conversations: the sample its share and win rate stand on."},"earlierCustomers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct customers of the segment's conversations in the window 30 days before, which its changes compare with; 0 when that window holds none."},"revenueInfluencedUsd":{"description":"Target revenue influenced over the as-of window; absent under a competitor lens.","anyOf":[{"type":"number"},{"type":"null"}]},"revenueInfluenceableUsd":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["id","name","shortName","color","vsPortfolioPts","brandShare","brandShareDelta","winRate","winRateDelta","customers","earlierCustomers"],"additionalProperties":false}},"drivers":{"$ref":"#/components/schemas/DiscoveryDrivers"},"audienceSeries":{"$ref":"#/components/schemas/DiscoveryAudienceSeries"},"portfolioShare":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"measured"},"value":{"type":"number"}},"required":["kind","value"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"absent"},"reason":{"type":"string","enum":["no_measurement_in_scope","no_conversations_in_segment"],"description":"`no_conversations_in_segment`: the segments left no conversation of the window; `no_measurement_in_scope`: the window, unnarrowed, holds none the figure counts."}},"required":["kind","reason"],"additionalProperties":false}],"description":"The figure (`kind` measured, `value` in percent), or `kind` absent with the `reason` nothing in scope measured it: never a 0 for an empty denominator."},"portfolioWinRate":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"measured"},"value":{"type":"number"}},"required":["kind","value"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"absent"},"reason":{"type":"string","enum":["no_measurement_in_scope","no_conversations_in_segment"],"description":"`no_conversations_in_segment`: the segments left no conversation of the window; `no_measurement_in_scope`: the window, unnarrowed, holds none the figure counts."}},"required":["kind","reason"],"additionalProperties":false}],"description":"The figure (`kind` measured, `value` in percent), or `kind` absent with the `reason` nothing in scope measured it: never a 0 for an empty denominator."}},"required":["segmentCountSeries","segmentCountDelta","conversationCount","revenueCoverage","segments","audiences","drivers","audienceSeries","portfolioShare","portfolioWinRate"],"additionalProperties":false},{"type":"null"}],"description":"Null unless `scope.state` is `ready`."}},"required":["scope","report"],"additionalProperties":false},"DiscoverySegmentWinRatesGetResponse":{"type":"object","properties":{"scope":{"$ref":"#/components/schemas/DiscoveryScope2"},"report":{"anyOf":[{"type":"object","properties":{"revenue":{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","description":"The revenue line's name; its id where none is known."},"winRate":{"type":"number","description":"Brand win rate (%)."}},"required":["id","name","winRate"],"additionalProperties":false},"description":"One row per revenue line, as discovery.revenue-reports.get lists them."},"portfolioWinRate":{"type":"number","description":"The campaign's all-up brand win rate (%), as discovery.revenue-reports.get states it."}},"required":["rows","portfolioWinRate"],"additionalProperties":false},"audience":{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","description":"The audience's name; its id where none is known."},"winRate":{"type":"number","description":"Brand win rate (%)."}},"required":["id","name","winRate"],"additionalProperties":false},"description":"One row per audience, as discovery.audience-reports.get lists them."},"portfolioWinRate":{"type":"number","description":"The campaign's all-up brand win rate (%), as discovery.audience-reports.get states it."}},"required":["rows","portfolioWinRate"],"additionalProperties":false},"measuredOn":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The results window's as-of day, labelled as the reports' superseded versions label a trend point (\"Oct 9\")."}},"required":["revenue","audience","measuredOn"],"additionalProperties":false},{"type":"null"}],"description":"Null unless `scope.state` is `ready`."}},"required":["scope","report"],"additionalProperties":false},"DiscoverySegmentWinRatesGetV2Response":{"type":"object","properties":{"scope":{"$ref":"#/components/schemas/DiscoveryScope"},"report":{"anyOf":[{"type":"object","properties":{"revenue":{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","description":"The revenue line's name; its id where none is known."},"winRate":{"type":"number","description":"Brand win rate (%)."}},"required":["id","name","winRate"],"additionalProperties":false},"description":"One row per revenue line, as discovery.revenue-reports.get lists them."},"portfolioWinRate":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"measured"},"value":{"type":"number"}},"required":["kind","value"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"absent"},"reason":{"type":"string","enum":["no_measurement_in_scope","no_conversations_in_segment"],"description":"`no_conversations_in_segment`: the segments left no conversation of the window; `no_measurement_in_scope`: the window, unnarrowed, holds none the figure counts."}},"required":["kind","reason"],"additionalProperties":false}],"description":"The campaign's all-up brand win rate (%), as discovery.revenue-reports.get states it."}},"required":["rows","portfolioWinRate"],"additionalProperties":false},"audience":{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","description":"The audience's name; its id where none is known."},"winRate":{"type":"number","description":"Brand win rate (%)."}},"required":["id","name","winRate"],"additionalProperties":false},"description":"One row per audience, as discovery.audience-reports.get lists them."},"portfolioWinRate":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"measured"},"value":{"type":"number"}},"required":["kind","value"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"absent"},"reason":{"type":"string","enum":["no_measurement_in_scope","no_conversations_in_segment"],"description":"`no_conversations_in_segment`: the segments left no conversation of the window; `no_measurement_in_scope`: the window, unnarrowed, holds none the figure counts."}},"required":["kind","reason"],"additionalProperties":false}],"description":"The campaign's all-up brand win rate (%), as discovery.audience-reports.get states it."}},"required":["rows","portfolioWinRate"],"additionalProperties":false},"channel":{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","description":"The channel's name; its id where none is known."},"winRate":{"type":"number","description":"Brand win rate (%)."}},"required":["id","name","winRate"],"additionalProperties":false},"description":"One row per channel, as discovery.channel-reports.get lists them."},"portfolioWinRate":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"measured"},"value":{"type":"number"}},"required":["kind","value"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"absent"},"reason":{"type":"string","enum":["no_measurement_in_scope","no_conversations_in_segment"],"description":"`no_conversations_in_segment`: the segments left no conversation of the window; `no_measurement_in_scope`: the window, unnarrowed, holds none the figure counts."}},"required":["kind","reason"],"additionalProperties":false}],"description":"The campaign's all-up brand win rate (%), as discovery.channel-reports.get states it."}},"required":["rows","portfolioWinRate"],"additionalProperties":false}},"required":["revenue","audience","channel"],"additionalProperties":false,"description":"As of the results window's as-of day."},{"type":"null"}],"description":"Null unless `scope.state` is `ready`."}},"required":["scope","report"],"additionalProperties":false},"DiscoveryChannelReportsGetV4Response":{"type":"object","properties":{"scope":{"$ref":"#/components/schemas/DiscoveryScope"},"report":{"anyOf":[{"type":"object","properties":{"brandScopes":{"$ref":"#/components/schemas/DiscoveryBrandScopes"},"segmentCountSeries":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"UTC day; the value is its trailing 30-day window's."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Null where that window holds no interaction."}},"required":["day","value"],"additionalProperties":false},"description":"Segments with a conversation in each day's window; null where it holds no conversation in scope."},"segmentCountDelta":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The segment count minus its count 30 days before the as-of day; null when that window holds no conversation in scope."},"conversationCount":{"type":"number","description":"The as-of window's conversations, narrowed like every other figure."},"revenueCoverage":{"type":"object","properties":{"scope":{"description":"Location estimates may overlap markets.","type":"string","const":"locations"},"status":{"type":"string","enum":["none","partial","complete"]},"includedLineCount":{"type":"number"},"totalLineCount":{"type":"number"},"coveredConversationCount":{"type":"number"},"totalConversationCount":{"type":"number"},"coveragePct":{"type":"number"}},"required":["status","includedLineCount","totalLineCount","coveredConversationCount","totalConversationCount","coveragePct"],"additionalProperties":false},"segments":{"type":"array","items":{"type":"object","properties":{"axis":{"type":"string","enum":["audience","channel","market","age","householdIncome","education","lifeStage","areaType","companySize","buyerRole","seniority","occupation","job","triggerType","intentStage","language","gender","product","engine","competitor","topic","sentiment","store","customer"],"description":"A pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or one `store` or `customer`."},"id":{"type":"string","minLength":1,"maxLength":300,"description":"The member's id on that axis, as `discovery.segment-options.get` lists it."}},"required":["axis","id"],"additionalProperties":false},"description":"The segments every figure was narrowed to, ANDed; empty is the whole campaign."},"breaks":{"description":"Days in the trends' span the campaign's conversations changed behavior version (its opening questions, customer replies or interview schedule), each with what changed; absent with none.","type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"label":{"type":"string"}},"required":["day","label"],"additionalProperties":false}},"channels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"color":{"type":"string"},"vsPortfolioPts":{"type":"number","description":"Brand win rate minus the campaign's all-up brand win rate, in points."},"topCompetitor":{"anyOf":[{"type":"string"},{"type":"null"}]},"isLeader":{"type":"boolean"},"parentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"level":{"type":"number","enum":[1,2,3]},"childIds":{"type":"array","items":{"type":"string"}},"brandShare":{"type":"number","description":"Brand share (%)."},"brandShareDelta":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The value minus its value 30 days before the window's as-of day; null when that window holds none of the segment's conversations."},"winRate":{"type":"number","description":"Brand win rate (%)."},"winRateDelta":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The value minus its value 30 days before the window's as-of day; null when that window holds none of the segment's conversations."},"customers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct customers of the segment's as-of window conversations: the sample its share and win rate stand on."},"earlierCustomers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct customers of the segment's conversations in the window 30 days before, which its changes compare with; 0 when that window holds none."},"revenueInfluencedUsd":{"description":"Target revenue influenced over the as-of window; absent under a competitor lens.","anyOf":[{"type":"number"},{"type":"null"}]},"revenueInfluenceableUsd":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["id","name","color","vsPortfolioPts","brandShare","brandShareDelta","winRate","winRateDelta","customers","earlierCustomers"],"additionalProperties":false}},"drivers":{"type":"array","items":{"type":"object","properties":{"channelId":{"type":"string"},"kind":{"type":"string","enum":["win","loss"]},"label":{"type":"string","description":"The reason, as the model wrote it."},"count":{"type":"number","description":"Conversations of the as-of window citing the reason."},"customers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct customers of the as-of window's conversations its kind counts from (wins for a win reason, losses for a loss reason): the sample its count stands on."},"series":{"description":"Its count in each day's window; null where the window holds none of its segment's conversations.","type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"UTC day; the value is its trailing 30-day window's."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Null where that window holds no interaction."}},"required":["day","value"],"additionalProperties":false}}},"required":["channelId","kind","label","count","customers"],"additionalProperties":false}},"channelSeries":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/DiscoveryLineSeries"},"description":"Keyed by channel id."},"portfolioShare":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"measured"},"value":{"type":"number"}},"required":["kind","value"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"absent"},"reason":{"type":"string","enum":["no_measurement_in_scope","no_conversations_in_segment"],"description":"`no_conversations_in_segment`: the segments left no conversation of the window; `no_measurement_in_scope`: the window, unnarrowed, holds none the figure counts."}},"required":["kind","reason"],"additionalProperties":false}],"description":"The figure (`kind` measured, `value` in percent), or `kind` absent with the `reason` nothing in scope measured it: never a 0 for an empty denominator."},"portfolioWinRate":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"measured"},"value":{"type":"number"}},"required":["kind","value"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"absent"},"reason":{"type":"string","enum":["no_measurement_in_scope","no_conversations_in_segment"],"description":"`no_conversations_in_segment`: the segments left no conversation of the window; `no_measurement_in_scope`: the window, unnarrowed, holds none the figure counts."}},"required":["kind","reason"],"additionalProperties":false}],"description":"The figure (`kind` measured, `value` in percent), or `kind` absent with the `reason` nothing in scope measured it: never a 0 for an empty denominator."}},"required":["segmentCountSeries","segmentCountDelta","conversationCount","revenueCoverage","segments","channels","drivers","channelSeries","portfolioShare","portfolioWinRate"],"additionalProperties":false},{"type":"null"}],"description":"Null unless `scope.state` is `ready`."}},"required":["scope","report"],"additionalProperties":false},"DiscoveryTopicReportsGetV4Response":{"type":"object","properties":{"scope":{"$ref":"#/components/schemas/DiscoveryScope"},"report":{"anyOf":[{"type":"object","properties":{"brandScopes":{"$ref":"#/components/schemas/DiscoveryBrandScopes"},"segmentCountSeries":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"UTC day; the value is its trailing 30-day window's."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Null where that window holds no interaction."}},"required":["day","value"],"additionalProperties":false},"description":"Segments with a conversation in each day's window; null where it holds no conversation in scope."},"segmentCountDelta":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The segment count minus its count 30 days before the as-of day; null when that window holds no conversation in scope."},"conversationCount":{"type":"number","description":"The as-of window's conversations, narrowed like every other figure."},"revenueCoverage":{"type":"object","properties":{"scope":{"description":"Location estimates may overlap markets.","type":"string","const":"locations"},"status":{"type":"string","enum":["none","partial","complete"]},"includedLineCount":{"type":"number"},"totalLineCount":{"type":"number"},"coveredConversationCount":{"type":"number"},"totalConversationCount":{"type":"number"},"coveragePct":{"type":"number"}},"required":["status","includedLineCount","totalLineCount","coveredConversationCount","totalConversationCount","coveragePct"],"additionalProperties":false},"segments":{"type":"array","items":{"type":"object","properties":{"axis":{"type":"string","enum":["audience","channel","market","age","householdIncome","education","lifeStage","areaType","companySize","buyerRole","seniority","occupation","job","triggerType","intentStage","language","gender","product","engine","competitor","topic","sentiment","store","customer"],"description":"A pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or one `store` or `customer`."},"id":{"type":"string","minLength":1,"maxLength":300,"description":"The member's id on that axis, as `discovery.segment-options.get` lists it."}},"required":["axis","id"],"additionalProperties":false},"description":"The segments every figure was narrowed to, ANDed; empty is the whole campaign."},"breaks":{"description":"Days in the trends' span the campaign's conversations changed behavior version (its opening questions, customer replies or interview schedule), each with what changed; absent with none.","type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"label":{"type":"string"}},"required":["day","label"],"additionalProperties":false}},"topics":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"color":{"type":"string"},"vsPortfolioPts":{"type":"number","description":"Topic win rate minus the campaign's all-up brand win rate, in points."},"topCompetitor":{"anyOf":[{"type":"string"},{"type":"null"}]},"isLeader":{"type":"boolean"},"brandShare":{"type":"number","description":"Brand share (%)."},"brandShareDelta":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The value minus its value 30 days before the window's as-of day; null when that window holds none of the segment's conversations."},"winRate":{"type":"number","description":"Brand win rate (%)."},"winRateDelta":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The value minus its value 30 days before the window's as-of day; null when that window holds none of the segment's conversations."},"customers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct customers of the segment's as-of window conversations: the sample its share and win rate stand on."},"earlierCustomers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct customers of the segment's conversations in the window 30 days before, which its changes compare with; 0 when that window holds none."},"revenueInfluencedUsd":{"description":"Target revenue influenced over the as-of window; absent under a competitor lens.","anyOf":[{"type":"number"},{"type":"null"}]},"revenueInfluenceableUsd":{"anyOf":[{"type":"number"},{"type":"null"}]},"prompts":{"type":"number","description":"The as-of window's conversations on the topic."},"share":{"type":"number","description":"The topic's share of all topic mentions in the as-of window (%)."}},"required":["id","name","shortName","color","vsPortfolioPts","brandShare","brandShareDelta","winRate","winRateDelta","customers","earlierCustomers","prompts","share"],"additionalProperties":false}},"drivers":{"type":"array","items":{"type":"object","properties":{"topicId":{"type":"string"},"kind":{"type":"string","enum":["win","loss"]},"label":{"type":"string","description":"The reason, as the model wrote it."},"count":{"type":"number","description":"Conversations of the as-of window citing the reason."},"customers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct customers of the as-of window's conversations its kind counts from (wins for a win reason, losses for a loss reason): the sample its count stands on."},"series":{"description":"Its count in each day's window; null where the window holds none of its segment's conversations.","type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"UTC day; the value is its trailing 30-day window's."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Null where that window holds no interaction."}},"required":["day","value"],"additionalProperties":false}}},"required":["topicId","kind","label","count","customers"],"additionalProperties":false}},"topicSeries":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/DiscoveryLineSeries"},"description":"Keyed by topic id."},"portfolioShare":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"measured"},"value":{"type":"number"}},"required":["kind","value"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"absent"},"reason":{"type":"string","enum":["no_measurement_in_scope","no_conversations_in_segment"],"description":"`no_conversations_in_segment`: the segments left no conversation of the window; `no_measurement_in_scope`: the window, unnarrowed, holds none the figure counts."}},"required":["kind","reason"],"additionalProperties":false}],"description":"The figure (`kind` measured, `value` in percent), or `kind` absent with the `reason` nothing in scope measured it: never a 0 for an empty denominator."},"portfolioWinRate":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"measured"},"value":{"type":"number"}},"required":["kind","value"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"absent"},"reason":{"type":"string","enum":["no_measurement_in_scope","no_conversations_in_segment"],"description":"`no_conversations_in_segment`: the segments left no conversation of the window; `no_measurement_in_scope`: the window, unnarrowed, holds none the figure counts."}},"required":["kind","reason"],"additionalProperties":false}],"description":"The figure (`kind` measured, `value` in percent), or `kind` absent with the `reason` nothing in scope measured it: never a 0 for an empty denominator."}},"required":["segmentCountSeries","segmentCountDelta","conversationCount","revenueCoverage","segments","topics","drivers","topicSeries","portfolioShare","portfolioWinRate"],"additionalProperties":false},{"type":"null"}],"description":"Null unless `scope.state` is `ready`."}},"required":["scope","report"],"additionalProperties":false},"DiscoveryEngineReportsGetV4Response":{"type":"object","properties":{"scope":{"$ref":"#/components/schemas/DiscoveryScope"},"report":{"anyOf":[{"type":"object","properties":{"brandScopes":{"$ref":"#/components/schemas/DiscoveryBrandScopes"},"segmentCountSeries":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"UTC day; the value is its trailing 30-day window's."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Null where that window holds no interaction."}},"required":["day","value"],"additionalProperties":false},"description":"Segments with a conversation in each day's window; null where it holds no conversation in scope."},"segmentCountDelta":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The segment count minus its count 30 days before the as-of day; null when that window holds no conversation in scope."},"conversationCount":{"type":"number","description":"The as-of window's conversations, narrowed like every other figure."},"revenueCoverage":{"type":"object","properties":{"scope":{"description":"Location estimates may overlap markets.","type":"string","const":"locations"},"status":{"type":"string","enum":["none","partial","complete"]},"includedLineCount":{"type":"number"},"totalLineCount":{"type":"number"},"coveredConversationCount":{"type":"number"},"totalConversationCount":{"type":"number"},"coveragePct":{"type":"number"}},"required":["status","includedLineCount","totalLineCount","coveredConversationCount","totalConversationCount","coveragePct"],"additionalProperties":false},"segments":{"type":"array","items":{"type":"object","properties":{"axis":{"type":"string","enum":["audience","channel","market","age","householdIncome","education","lifeStage","areaType","companySize","buyerRole","seniority","occupation","job","triggerType","intentStage","language","gender","product","engine","competitor","topic","sentiment","store","customer"],"description":"A pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or one `store` or `customer`."},"id":{"type":"string","minLength":1,"maxLength":300,"description":"The member's id on that axis, as `discovery.segment-options.get` lists it."}},"required":["axis","id"],"additionalProperties":false},"description":"The segments every figure was narrowed to, ANDed; empty is the whole campaign."},"breaks":{"description":"Days in the trends' span the campaign's conversations changed behavior version (its opening questions, customer replies or interview schedule), each with what changed; absent with none.","type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"label":{"type":"string"}},"required":["day","label"],"additionalProperties":false}},"engines":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"color":{"type":"string"},"vsPortfolioPts":{"type":"number","description":"Brand win rate minus the campaign's all-up brand win rate, in points."},"bestTopic":{"anyOf":[{"type":"string"},{"type":"null"}]},"brandShare":{"type":"number","description":"Brand share (%)."},"brandShareDelta":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The value minus its value 30 days before the window's as-of day; null when that window holds none of the segment's conversations."},"winRate":{"type":"number","description":"Brand win rate (%)."},"winRateDelta":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The value minus its value 30 days before the window's as-of day; null when that window holds none of the segment's conversations."},"customers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct customers of the segment's as-of window conversations: the sample its share and win rate stand on."},"earlierCustomers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct customers of the segment's conversations in the window 30 days before, which its changes compare with; 0 when that window holds none."},"revenueInfluencedUsd":{"description":"Target revenue influenced over the as-of window; absent under a competitor lens.","anyOf":[{"type":"number"},{"type":"null"}]},"revenueInfluenceableUsd":{"anyOf":[{"type":"number"},{"type":"null"}]},"prompts":{"type":"number","description":"The as-of window's conversations the engine answered."},"models":{"type":"array","items":{"type":"string"},"description":"The models those conversations recorded (Point11 ran each in the assistant's place), most conversations first."}},"required":["id","name","shortName","color","vsPortfolioPts","bestTopic","brandShare","brandShareDelta","winRate","winRateDelta","customers","earlierCustomers","prompts","models"],"additionalProperties":false}},"drivers":{"type":"array","items":{"type":"object","properties":{"engineId":{"type":"string"},"kind":{"type":"string","enum":["win","loss"]},"label":{"type":"string","description":"The reason, as the model wrote it."},"count":{"type":"number","description":"Conversations of the as-of window citing the reason."},"customers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct customers of the as-of window's conversations its kind counts from (wins for a win reason, losses for a loss reason): the sample its count stands on."},"series":{"description":"Its count in each day's window; null where the window holds none of its segment's conversations.","type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"UTC day; the value is its trailing 30-day window's."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Null where that window holds no interaction."}},"required":["day","value"],"additionalProperties":false}}},"required":["engineId","kind","label","count","customers"],"additionalProperties":false}},"engineSeries":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/DiscoveryLineSeries"},"description":"Keyed by engine id."}},"required":["segmentCountSeries","segmentCountDelta","conversationCount","revenueCoverage","segments","engines","drivers","engineSeries"],"additionalProperties":false},{"type":"null"}],"description":"Null unless `scope.state` is `ready`."}},"required":["scope","report"],"additionalProperties":false},"DiscoveryCompetitorReportsGetV4Response":{"type":"object","properties":{"scope":{"$ref":"#/components/schemas/DiscoveryScope"},"report":{"anyOf":[{"type":"object","properties":{"segments":{"readOnly":true,"description":"The segments every figure was narrowed to, ANDed; empty is the whole campaign.","type":"array","items":{"type":"object","properties":{"axis":{"type":"string","enum":["audience","channel","market","age","householdIncome","education","lifeStage","areaType","companySize","buyerRole","seniority","occupation","job","triggerType","intentStage","language","gender","product","engine","competitor","topic","sentiment","store","customer"],"description":"A pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or one `store` or `customer`."},"id":{"type":"string","minLength":1,"maxLength":300,"description":"The member's id on that axis, as `discovery.segment-options.get` lists it."}},"required":["axis","id"],"additionalProperties":false}},"conversationCount":{"type":"number","description":"The as-of window's conversations, narrowed like every figure."},"customerCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct customers of those conversations: the sample every brand's share and win rate stand on."},"earlierCustomerCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct customers of the conversations in the window 30 days before, which every change compares with."},"competitors":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"color":{"type":"string"},"faviconUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"faviconLightUrl":{"description":"Never sent: a source's favicon is one image for both themes, faviconUrl.","type":"null"},"faviconDarkUrl":{"description":"Never sent: a source's favicon is one image for both themes, faviconUrl.","type":"null"},"faviconFallbackLabel":{"anyOf":[{"type":"string"},{"type":"null"}]},"faviconTone":{"anyOf":[{"type":"string","enum":["dark","light","mixed","unknown"]},{"type":"null"}]},"faviconTransparent":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"faviconNeedsLightBackplate":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"faviconNeedsDarkBackplate":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"brandColor":{"description":"The campaign's assigned color token for this brand.","anyOf":[{"type":"string"},{"type":"null"}]},"relationshipType":{"description":"How the brand relates to the lens brand.","type":"string","enum":["target","competitor","partner","hybrid","influencer","adjacent","unrelated","unknown"]},"relationshipTypeCounts":{"type":"object","propertyNames":{"type":"string","enum":["competitor","partner","hybrid","influencer","adjacent","unrelated","unknown"]},"additionalProperties":{"type":"number"},"description":"How often the relationship analysis's models gave the brand each label, for the labels given at least once; its relationship type is the label given most often."},"brandShare":{"type":"number","description":"Percent of conversations mentioning the brand."},"winRate":{"type":"number","description":"Percent of the brand's conversations it won."},"conversations":{"type":"number","description":"Conversations mentioning the brand."},"mappedRelationshipCount":{"type":"number"},"vsUs":{"type":"object","properties":{"kind":{"type":"string","enum":["win","lose","self"]},"pct":{"type":"number"}},"required":["kind"],"additionalProperties":false,"description":"Its head-to-head record against the lens brand; `self` is the lens brand."},"isUs":{"description":"True for the lens brand itself.","type":"boolean"},"brandShareDelta":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The value minus its value 30 days before the window's as-of day; null when that window holds no conversation in scope."},"winRateDelta":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The value minus its value 30 days before the window's as-of day; null when that window holds no conversation in scope."}},"required":["id","name","color","brandShare","winRate","conversations","vsUs","brandShareDelta","winRateDelta"],"additionalProperties":false,"description":"As of the window's as-of day."}},"drivers":{"$ref":"#/components/schemas/DiscoveryReportDrivers"},"threats":{"type":"array","items":{"type":"object","properties":{"competitorId":{"type":"string"},"description":{"type":"string"}},"required":["competitorId","description"],"additionalProperties":false}},"competitorSeries":{"$ref":"#/components/schemas/DiscoveryCompetitorSeries"},"segmentCountSeries":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"UTC day; the value is its trailing 30-day window's."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Null where that window holds no interaction."}},"required":["day","value"],"additionalProperties":false},"description":"Rival brands named in each day's window; null where it holds no conversation in scope."},"segmentCountDelta":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The segment count minus its count 30 days before the as-of day; null when that window holds no conversation in scope."},"breaks":{"description":"Days in the trends' span the campaign's conversations changed behavior version (its opening questions, customer replies or interview schedule), each with what changed; absent with none.","type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"label":{"type":"string"}},"required":["day","label"],"additionalProperties":false}}},"required":["segments","conversationCount","customerCount","earlierCustomerCount","competitors","drivers","threats","competitorSeries","segmentCountSeries","segmentCountDelta"],"additionalProperties":false},{"type":"null"}],"description":"Null unless `scope.state` is `ready`."}},"required":["scope","report"],"additionalProperties":false},"DiscoveryCompetitorReportsGetV5Response":{"type":"object","properties":{"scope":{"$ref":"#/components/schemas/DiscoveryScope"},"report":{"anyOf":[{"type":"object","properties":{"segments":{"readOnly":true,"description":"The segments every figure was narrowed to, ANDed; empty is the whole campaign.","type":"array","items":{"type":"object","properties":{"axis":{"type":"string","enum":["audience","channel","market","age","householdIncome","education","lifeStage","areaType","companySize","buyerRole","seniority","occupation","job","triggerType","intentStage","language","gender","product","engine","competitor","topic","sentiment","store","customer"],"description":"A pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or one `store` or `customer`."},"id":{"type":"string","minLength":1,"maxLength":300,"description":"The member's id on that axis, as `discovery.segment-options.get` lists it."}},"required":["axis","id"],"additionalProperties":false}},"conversationCount":{"type":"number","description":"The as-of window's conversations, narrowed like every figure."},"customerCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct customers of those conversations: the sample every brand's share and win rate stand on."},"earlierCustomerCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct customers of the conversations in the window 30 days before, which every change compares with."},"competitors":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"color":{"type":"string"},"faviconUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"faviconFallbackLabel":{"anyOf":[{"type":"string"},{"type":"null"}]},"faviconTone":{"anyOf":[{"type":"string","enum":["dark","light","mixed","unknown"]},{"type":"null"}]},"faviconTransparent":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"faviconNeedsLightBackplate":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"faviconNeedsDarkBackplate":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"brandColor":{"description":"The campaign's assigned color token for this brand.","anyOf":[{"type":"string"},{"type":"null"}]},"relationshipType":{"description":"How the brand relates to the lens brand.","type":"string","enum":["target","competitor","partner","hybrid","influencer","adjacent","unrelated","unknown"]},"relationshipTypeCounts":{"type":"object","propertyNames":{"type":"string","enum":["competitor","partner","hybrid","influencer","adjacent","unrelated","unknown"]},"additionalProperties":{"type":"number"},"description":"How often the relationship analysis's models gave the brand each label, for the labels given at least once; its relationship type is the label given most often."},"brandShare":{"type":"number","description":"Percent of conversations mentioning the brand."},"winRate":{"type":"number","description":"Percent of the brand's conversations it won."},"conversations":{"type":"number","description":"Conversations mentioning the brand."},"mappedRelationshipCount":{"type":"number"},"vsUs":{"type":"object","properties":{"kind":{"type":"string","enum":["win","lose","self"]},"pct":{"type":"number"}},"required":["kind"],"additionalProperties":false,"description":"Its head-to-head record against the lens brand; `self` is the lens brand."},"isUs":{"description":"True for the lens brand itself.","type":"boolean"},"brandShareDelta":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The value minus its value 30 days before the window's as-of day; null when that window holds no conversation in scope."},"winRateDelta":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The value minus its value 30 days before the window's as-of day; null when that window holds no conversation in scope."}},"required":["id","name","color","brandShare","winRate","conversations","vsUs","brandShareDelta","winRateDelta"],"additionalProperties":false,"description":"As of the window's as-of day."}},"drivers":{"$ref":"#/components/schemas/DiscoveryReportDrivers"},"threats":{"type":"array","items":{"type":"object","properties":{"competitorId":{"type":"string"},"description":{"type":"string"}},"required":["competitorId","description"],"additionalProperties":false}},"competitorSeries":{"$ref":"#/components/schemas/DiscoveryCompetitorSeries"},"segmentCountSeries":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"UTC day; the value is its trailing 30-day window's."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Null where that window holds no interaction."}},"required":["day","value"],"additionalProperties":false},"description":"Rival brands named in each day's window; null where it holds no conversation in scope."},"segmentCountDelta":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The segment count minus its count 30 days before the as-of day; null when that window holds no conversation in scope."},"breaks":{"description":"Days in the trends' span the campaign's conversations changed behavior version (its opening questions, customer replies or interview schedule), each with what changed; absent with none.","type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"label":{"type":"string"}},"required":["day","label"],"additionalProperties":false}}},"required":["segments","conversationCount","customerCount","earlierCustomerCount","competitors","drivers","threats","competitorSeries","segmentCountSeries","segmentCountDelta"],"additionalProperties":false},{"type":"null"}],"description":"Null unless `scope.state` is `ready`."}},"required":["scope","report"],"additionalProperties":false},"DiscoverySentimentReportsGetV4Response":{"type":"object","properties":{"scope":{"$ref":"#/components/schemas/DiscoveryScope"},"report":{"anyOf":[{"type":"object","properties":{"brandScopes":{"$ref":"#/components/schemas/DiscoveryBrandScopes"},"positivePhraseTotalCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"How many positive phrases the campaign's conversations hold."},"negativePhraseTotalCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"How many negative phrases the campaign's conversations hold."},"sentimentMentionCount":{"type":"number","description":"The lens brand's positive plus negative sentiment phrase mentions."},"segments":{"type":"array","items":{"type":"object","properties":{"axis":{"type":"string","enum":["audience","channel","market","age","householdIncome","education","lifeStage","areaType","companySize","buyerRole","seniority","occupation","job","triggerType","intentStage","language","gender","product","engine","competitor","topic","sentiment","store","customer"],"description":"A pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or one `store` or `customer`."},"id":{"type":"string","minLength":1,"maxLength":300,"description":"The member's id on that axis, as `discovery.segment-options.get` lists it."}},"required":["axis","id"],"additionalProperties":false},"description":"The segments every figure was narrowed to, ANDed; empty is the whole campaign."},"themes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"color":{"type":"string"},"mentions":{"type":"number"},"positiveMentions":{"type":"number"},"negativeMentions":{"type":"number"},"mentionShare":{"type":"number","description":"The theme's share of sentiment mentions (%)."},"netSentiment":{"type":"number","description":"Positive minus negative share of the theme (%)."},"netSentimentDelta":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The value minus its value 30 days before the window's as-of day; null when that window holds no conversation in scope. Null too when that window never drew the theme."},"vsPortfolioPts":{"type":"number","description":"Theme net sentiment minus the campaign's all-up net sentiment, in points."},"topCompetitor":{"anyOf":[{"type":"string"},{"type":"null"}]},"mentionShareDelta":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The value minus its value 30 days before the window's as-of day; null when that window holds no conversation in scope."}},"required":["id","name","shortName","color","mentions","positiveMentions","negativeMentions","mentionShare","netSentiment","netSentimentDelta","vsPortfolioPts","mentionShareDelta"],"additionalProperties":false,"description":"As of the window's as-of day."}},"positivePhrases":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string","description":"The phrase, as the model wrote it."},"count":{"type":"number","description":"Mentions of the phrase."},"series":{"description":"Its mentions in each day's window; null where it holds no conversation in scope.","type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"UTC day; the value is its trailing 30-day window's."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Null where that window holds no interaction."}},"required":["day","value"],"additionalProperties":false}}},"required":["text","count"],"additionalProperties":false},"description":"The most mentioned positive phrases, at most 25; positivePhraseTotalCount says how many there are."},"negativePhrases":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string","description":"The phrase, as the model wrote it."},"count":{"type":"number","description":"Mentions of the phrase."},"series":{"description":"Its mentions in each day's window; null where it holds no conversation in scope.","type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"UTC day; the value is its trailing 30-day window's."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Null where that window holds no interaction."}},"required":["day","value"],"additionalProperties":false}}},"required":["text","count"],"additionalProperties":false},"description":"The most mentioned negative phrases, at most 25; negativePhraseTotalCount says how many there are."},"themeSeries":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"object","properties":{"mentionShareTrend":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"UTC day; the value is its trailing 30-day window's."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Null where that window holds no interaction."}},"required":["day","value"],"additionalProperties":false},"description":"Mention share (%) in each day's window; null where it holds no conversation in scope."},"netSentimentTrend":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"UTC day; the value is its trailing 30-day window's."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Null where that window holds no interaction."}},"required":["day","value"],"additionalProperties":false},"description":"Net sentiment (%) in each day's window; null where it never drew the theme."}},"required":["mentionShareTrend","netSentimentTrend"],"additionalProperties":false},"description":"Keyed by theme id."},"segmentCountSeries":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"UTC day; the value is its trailing 30-day window's."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Null where that window holds no interaction."}},"required":["day","value"],"additionalProperties":false},"description":"Themes drawn in each day's window; null where it holds no conversation in scope."},"segmentCountDelta":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The segment count minus its count 30 days before the as-of day; null when that window holds no conversation in scope."},"breaks":{"description":"Days in the trends' span the campaign's conversations changed behavior version (its opening questions, customer replies or interview schedule), each with what changed; absent with none.","type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"label":{"type":"string"}},"required":["day","label"],"additionalProperties":false}}},"required":["positivePhraseTotalCount","negativePhraseTotalCount","sentimentMentionCount","segments","themes","positivePhrases","negativePhrases","themeSeries","segmentCountSeries","segmentCountDelta"],"additionalProperties":false},{"type":"null"}],"description":"Null unless `scope.state` is `ready`."}},"required":["scope","report"],"additionalProperties":false},"DiscoverySourceReportsGetResponse":{"type":"object","properties":{"scope":{"$ref":"#/components/schemas/DiscoveryScope2"},"report":{"anyOf":[{"type":"object","properties":{"conversationCount":{"type":"number","description":"The as-of window's conversations in scope, narrowed like every figure."},"sources":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"displayNameSource":{"anyOf":[{"type":"string"},{"type":"null"}]},"displayNameConfidence":{"anyOf":[{"type":"number"},{"type":"null"}]},"reviewStatus":{"anyOf":[{"type":"string"},{"type":"null"}]},"color":{"type":"string"},"faviconUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"faviconLightUrl":{"description":"Never sent: a source's favicon is one image for both themes, faviconUrl.","type":"null"},"faviconDarkUrl":{"description":"Never sent: a source's favicon is one image for both themes, faviconUrl.","type":"null"},"faviconStatus":{"anyOf":[{"type":"string"},{"type":"null"}]},"faviconFallbackLabel":{"type":"string"},"faviconTone":{"anyOf":[{"type":"string","enum":["dark","light","mixed","unknown"]},{"type":"null"}]},"faviconTransparent":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"faviconNeedsLightBackplate":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"faviconNeedsDarkBackplate":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"citations":{"type":"number"},"share":{"type":"number","description":"The source's share of all citations (%)."},"winCount":{"type":"number"},"lossCount":{"type":"number"},"winImpact":{"type":"number"},"influenceWeight":{"type":"number"},"influenceShare":{"type":"number"},"influenceConversationCount":{"type":"number"},"winInfluence":{"type":"number"},"lossInfluence":{"type":"number"},"netInfluence":{"type":"number"},"averageInfluenceRank":{"anyOf":[{"type":"number"},{"type":"null"}]},"topInfluenceKind":{"anyOf":[{"type":"string"},{"type":"null"}]},"isOwned":{"type":"boolean","description":"True when the page is the campaign brand's own."},"sourceFamily":{"type":"string","enum":["brand_site","third_party_site"],"description":"A brand's own site, or a third-party site."},"ownerType":{"type":"string","enum":["target_owned","competitor_owned","third_party","unknown"]},"sourceSubtype":{"type":"string","enum":["target_brand","competitor","social_media","news","review_site","marketplace","community","documentation","comparison","pricing","third_party","unknown"]},"functionalType":{"type":"string","enum":["owned_site","documentation","pricing","marketplace","review","news","community","social","comparison","unknown"]},"pageType":{"type":"string","enum":["homepage","article","product_page","pricing_page","documentation_page","marketplace_listing","review_page","social_profile","social_post","community_thread","comparison_page","unknown"]},"siteKind":{"type":"string","description":"Emergent site-type label."},"pageKind":{"type":"string","description":"Emergent page-type label."},"typeLabel":{"type":"string","enum":["Our content","Third party"]}},"required":["id","name","url","displayNameSource","displayNameConfidence","reviewStatus","color","faviconUrl","faviconStatus","faviconFallbackLabel","citations","share","winCount","lossCount","winImpact","influenceWeight","influenceShare","influenceConversationCount","winInfluence","lossInfluence","netInfluence","averageInfluenceRank","topInfluenceKind","isOwned","sourceFamily","ownerType","sourceSubtype","functionalType","pageType","siteKind","pageKind","typeLabel"],"additionalProperties":false}},"drivers":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["win","loss"]},"label":{"type":"string","description":"The reason, as the model wrote it."},"count":{"type":"number","description":"Conversations of the as-of window citing the reason."},"series":{"type":"array","items":{"type":"object","properties":{"month":{"type":"string"},"value":{"type":"number"}},"required":["month","value"],"additionalProperties":false}}},"required":["kind","label","count"],"additionalProperties":false}},"sourceSeries":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"object","properties":{"shareTrend":{"type":"array","items":{"type":"object","properties":{"month":{"type":"string"},"value":{"type":"number"}},"required":["month","value"],"additionalProperties":false},"description":"Citation share (%) per day with a value."},"winTrend":{"type":"array","items":{"type":"object","properties":{"month":{"type":"string"},"value":{"type":"number"}},"required":["month","value"],"additionalProperties":false},"description":"Citation count per day with a value."}},"required":["shareTrend","winTrend"],"additionalProperties":false},"description":"Keyed by source id."},"segmentCountSeries":{"type":"array","items":{"type":"object","properties":{"month":{"type":"string"},"value":{"type":"number"}},"required":["month","value"],"additionalProperties":false}}},"required":["conversationCount","sources","drivers","sourceSeries","segmentCountSeries"],"additionalProperties":false},{"type":"null"}],"description":"Null unless `scope.state` is `ready`."}},"required":["scope","report"],"additionalProperties":false},"DiscoverySourceReportsGetV2Response":{"type":"object","properties":{"scope":{"$ref":"#/components/schemas/DiscoveryScope"},"report":{"anyOf":[{"type":"object","properties":{"conversationCount":{"type":"number","description":"The as-of window's conversations in scope, narrowed like every figure."},"sources":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"displayNameSource":{"anyOf":[{"type":"string"},{"type":"null"}]},"displayNameConfidence":{"anyOf":[{"type":"number"},{"type":"null"}]},"reviewStatus":{"anyOf":[{"type":"string"},{"type":"null"}]},"color":{"type":"string"},"faviconUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"faviconLightUrl":{"description":"Never sent: a source's favicon is one image for both themes, faviconUrl.","type":"null"},"faviconDarkUrl":{"description":"Never sent: a source's favicon is one image for both themes, faviconUrl.","type":"null"},"faviconStatus":{"anyOf":[{"type":"string"},{"type":"null"}]},"faviconFallbackLabel":{"type":"string"},"faviconTone":{"anyOf":[{"type":"string","enum":["dark","light","mixed","unknown"]},{"type":"null"}]},"faviconTransparent":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"faviconNeedsLightBackplate":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"faviconNeedsDarkBackplate":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"citations":{"type":"number"},"share":{"type":"number","description":"The source's share of all citations (%)."},"winCount":{"type":"number"},"lossCount":{"type":"number"},"winImpact":{"type":"number"},"influenceWeight":{"type":"number"},"influenceShare":{"type":"number"},"influenceConversationCount":{"type":"number"},"winInfluence":{"type":"number"},"lossInfluence":{"type":"number"},"netInfluence":{"type":"number"},"averageInfluenceRank":{"anyOf":[{"type":"number"},{"type":"null"}]},"topInfluenceKind":{"anyOf":[{"type":"string"},{"type":"null"}]},"isOwned":{"type":"boolean","description":"True when the page is the campaign brand's own."},"sourceFamily":{"type":"string","enum":["brand_site","third_party_site"],"description":"A brand's own site, or a third-party site."},"ownerType":{"type":"string","enum":["target_owned","competitor_owned","third_party","unknown"]},"sourceSubtype":{"type":"string","enum":["target_brand","competitor","social_media","news","review_site","marketplace","community","documentation","comparison","pricing","third_party","unknown"]},"functionalType":{"type":"string","enum":["owned_site","documentation","pricing","marketplace","review","news","community","social","comparison","unknown"]},"pageType":{"type":"string","enum":["homepage","article","product_page","pricing_page","documentation_page","marketplace_listing","review_page","social_profile","social_post","community_thread","comparison_page","unknown"]},"siteKind":{"type":"string","description":"Emergent site-type label."},"pageKind":{"type":"string","description":"Emergent page-type label."},"typeLabel":{"type":"string","enum":["Our content","Third party"]},"shareDelta":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Its share of the listed sources' citations minus that share 30 days before the as-of day; null when that window holds no conversation in scope or the source is not listed."}},"required":["id","name","url","displayNameSource","displayNameConfidence","reviewStatus","color","faviconUrl","faviconStatus","faviconFallbackLabel","citations","share","winCount","lossCount","winImpact","influenceWeight","influenceShare","influenceConversationCount","winInfluence","lossInfluence","netInfluence","averageInfluenceRank","topInfluenceKind","isOwned","sourceFamily","ownerType","sourceSubtype","functionalType","pageType","siteKind","pageKind","typeLabel","shareDelta"],"additionalProperties":false}},"drivers":{"$ref":"#/components/schemas/DiscoveryReportDrivers2"},"sourceSeries":{"$ref":"#/components/schemas/DiscoverySourceSeries"},"segmentCountSeries":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"UTC day; the value is its trailing 30-day window's."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Null where that window holds no interaction."}},"required":["day","value"],"additionalProperties":false},"description":"Listed sources cited in each day's window; null where it holds no conversation in scope."},"segmentCountDelta":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The segment count minus its count 30 days before the as-of day; null when that window holds no conversation in scope."}},"required":["conversationCount","sources","drivers","sourceSeries","segmentCountSeries","segmentCountDelta"],"additionalProperties":false},{"type":"null"}],"description":"Null unless `scope.state` is `ready`."}},"required":["scope","report"],"additionalProperties":false},"DiscoverySourceReportsGetV3Response":{"type":"object","properties":{"scope":{"$ref":"#/components/schemas/DiscoveryScope"},"report":{"anyOf":[{"type":"object","properties":{"conversationCount":{"type":"number","description":"The as-of window's conversations in scope, narrowed like every figure."},"sources":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"displayNameSource":{"anyOf":[{"type":"string"},{"type":"null"}]},"displayNameConfidence":{"anyOf":[{"type":"number"},{"type":"null"}]},"reviewStatus":{"anyOf":[{"type":"string"},{"type":"null"}]},"color":{"type":"string"},"faviconUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"faviconStatus":{"anyOf":[{"type":"string"},{"type":"null"}]},"faviconFallbackLabel":{"type":"string"},"faviconTone":{"anyOf":[{"type":"string","enum":["dark","light","mixed","unknown"]},{"type":"null"}]},"faviconTransparent":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"faviconNeedsLightBackplate":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"faviconNeedsDarkBackplate":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"citations":{"type":"number"},"share":{"type":"number","description":"The source's share of all citations (%)."},"winCount":{"type":"number"},"lossCount":{"type":"number"},"winImpact":{"type":"number"},"influenceWeight":{"type":"number"},"influenceShare":{"type":"number"},"influenceConversationCount":{"type":"number"},"winInfluence":{"type":"number"},"lossInfluence":{"type":"number"},"netInfluence":{"type":"number"},"averageInfluenceRank":{"anyOf":[{"type":"number"},{"type":"null"}]},"topInfluenceKind":{"anyOf":[{"type":"string"},{"type":"null"}]},"isOwned":{"type":"boolean","description":"True when the page is the campaign brand's own."},"sourceFamily":{"type":"string","enum":["brand_site","third_party_site"],"description":"A brand's own site, or a third-party site."},"ownerType":{"type":"string","enum":["target_owned","competitor_owned","third_party","unknown"]},"sourceSubtype":{"type":"string","enum":["target_brand","competitor","social_media","news","review_site","marketplace","community","documentation","comparison","pricing","third_party","unknown"]},"functionalType":{"type":"string","enum":["owned_site","documentation","pricing","marketplace","review","news","community","social","comparison","unknown"]},"pageType":{"type":"string","enum":["homepage","article","product_page","pricing_page","documentation_page","marketplace_listing","review_page","social_profile","social_post","community_thread","comparison_page","unknown"]},"siteKind":{"type":"string","description":"Emergent site-type label."},"pageKind":{"type":"string","description":"Emergent page-type label."},"typeLabel":{"type":"string","enum":["Our content","Third party"]},"shareDelta":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Its share of the listed sources' citations minus that share 30 days before the as-of day; null when that window holds no conversation in scope or the source is not listed."}},"required":["id","name","url","displayNameSource","displayNameConfidence","reviewStatus","color","faviconUrl","faviconStatus","faviconFallbackLabel","citations","share","winCount","lossCount","winImpact","influenceWeight","influenceShare","influenceConversationCount","winInfluence","lossInfluence","netInfluence","averageInfluenceRank","topInfluenceKind","isOwned","sourceFamily","ownerType","sourceSubtype","functionalType","pageType","siteKind","pageKind","typeLabel","shareDelta"],"additionalProperties":false}},"drivers":{"$ref":"#/components/schemas/DiscoveryReportDrivers2"},"sourceSeries":{"$ref":"#/components/schemas/DiscoverySourceSeries"},"segmentCountSeries":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"UTC day; the value is its trailing 30-day window's."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Null where that window holds no interaction."}},"required":["day","value"],"additionalProperties":false},"description":"Listed sources cited in each day's window; null where it holds no conversation in scope."},"segmentCountDelta":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The segment count minus its count 30 days before the as-of day; null when that window holds no conversation in scope."}},"required":["conversationCount","sources","drivers","sourceSeries","segmentCountSeries","segmentCountDelta"],"additionalProperties":false},{"type":"null"}],"description":"Null unless `scope.state` is `ready`."}},"required":["scope","report"],"additionalProperties":false},"DiscoveryJourneyMapsGetV3Response":{"type":"object","properties":{"scope":{"$ref":"#/components/schemas/DiscoveryScope"},"map":{"anyOf":[{"type":"object","properties":{"datasetKey":{"type":"string"},"customerCount":{"type":"number","description":"The as-of window's conversations, one per customer and assistant asked."},"measures":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","enum":["wins","share","market"]},"label":{"type":"string"},"unit":{"type":"string","enum":["customers","usd"]},"exclusive":{"type":"boolean","description":"Whether a conversation lands on at most one brand; an exclusive measure leaves what reached no brand as a remainder."},"total":{"type":"number","description":"The whole a brand's value is read against."},"brands":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"value":{"type":"number"}},"required":["key","name","value"],"additionalProperties":false}},"groupings":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","enum":["decision-factors","revenue","audiences","channels","topics","locations","engines"]},"flows":{"type":"array","items":{"type":"object","properties":{"segmentId":{"type":"string"},"brandKey":{"type":"string"},"value":{"type":"number"}},"required":["segmentId","brandKey","value"],"additionalProperties":false}},"weights":{"description":"Each segment's weight by segment id; absent where it weighs its customers.","type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"number"}}},"required":["key","flows"],"additionalProperties":false}}},"required":["key","label","unit","exclusive","total","brands","groupings"],"additionalProperties":false},"description":"The ways to measure the brand column; the first is the default."},"segmentations":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","enum":["decision-factors","revenue","audiences","channels","topics","locations","engines"]},"label":{"type":"string"},"segments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"count":{"type":"number"},"share":{"type":"number","description":"Share of all the as-of window's conversations."},"scope":{"description":"The segment-scope key naming exactly this bucket, when one does.","type":"object","properties":{"axis":{"type":"string","enum":["audience","channel","topic","engine"]},"id":{"type":"string"}},"required":["axis","id"],"additionalProperties":false}},"required":["id","label","count","share"],"additionalProperties":false}}},"required":["key","label","segments"],"additionalProperties":false},"description":"The grouping dimensions with data in the window; the first is the default."},"brandNames":{"type":"array","items":{"type":"string"},"description":"The brand names whose favicons `discovery.brand-icons.get.v2` reads for this map."},"targetBrandKey":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["datasetKey","customerCount","measures","segmentations","brandNames","targetBrandKey"],"additionalProperties":false},{"type":"null"}],"description":"Null unless `scope.state` is `ready`."}},"required":["scope","map"],"additionalProperties":false},"DiscoveryBrandMapsGetResponse":{"type":"object","properties":{"scope":{"$ref":"#/components/schemas/DiscoveryScope2"},"map":{"anyOf":[{"type":"object","properties":{"datasetKey":{"type":"string"},"ladder":{"$ref":"#/components/schemas/DiscoveryLadder"},"edges":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string","description":"The matchup's overall winner."},"target":{"type":"string"},"wins":{"type":"number"},"losses":{"type":"number"},"total":{"type":"number"},"confident":{"type":"boolean","description":"The Wilson 95% lower bound of the winner's share exceeds 50%."}},"required":["source","target","wins","losses","total","confident"],"additionalProperties":false}},"defaultRing":{"description":"The ring's priority after the center: before any hand-pick the canvas draws the center, then these brand keys the center has met, then its other opponents, to the cap.","type":"array","items":{"type":"string"}},"summary":{"type":"object","properties":{"totalBrandCount":{"type":"number"},"targetDecidedMatchupTotal":{"type":"number"}},"required":["totalBrandCount","targetDecidedMatchupTotal"],"additionalProperties":false},"brandNames":{"type":"array","items":{"type":"string"},"description":"The brand names whose favicons `discovery.brand-icons.get.v2` reads for this map."}},"required":["datasetKey","ladder","edges","brandNames"],"additionalProperties":false},{"type":"null"}],"description":"Null unless `scope.state` is `ready`."}},"required":["scope","map"],"additionalProperties":false},"DiscoveryBrandMapsGetV2Response":{"type":"object","properties":{"scope":{"$ref":"#/components/schemas/DiscoveryScope"},"map":{"anyOf":[{"type":"object","properties":{"datasetKey":{"type":"string"},"ladder":{"$ref":"#/components/schemas/DiscoveryLadder"},"edges":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string","description":"The matchup's overall winner."},"target":{"type":"string"},"wins":{"type":"number"},"losses":{"type":"number"},"total":{"type":"number"}},"required":["source","target","wins","losses","total"],"additionalProperties":false}},"defaultRing":{"description":"The ring's priority after the center: before any hand-pick the canvas draws the center, then these brand keys the center has met, then its other opponents, to the cap.","type":"array","items":{"type":"string"}},"summary":{"type":"object","properties":{"totalBrandCount":{"type":"number"},"targetDecidedMatchupTotal":{"type":"number"}},"required":["totalBrandCount","targetDecidedMatchupTotal"],"additionalProperties":false},"brandNames":{"type":"array","items":{"type":"string"},"description":"The brand names whose favicons `discovery.brand-icons.get.v2` reads for this map."}},"required":["datasetKey","ladder","edges","brandNames"],"additionalProperties":false},{"type":"null"}],"description":"Null unless `scope.state` is `ready`."}},"required":["scope","map"],"additionalProperties":false},"DiscoverySourceMapsGetResponse":{"type":"object","properties":{"scope":{"$ref":"#/components/schemas/DiscoveryScope2"},"map":{"anyOf":[{"type":"object","properties":{"summary":{"type":"object","properties":{"conversationCount":{"type":"number"},"typeCount":{"type":"number"},"sourceCount":{"type":"number"},"brandShare":{"type":"number","description":"Share (0..1) of influence carried by brand-owned pages."},"independentShare":{"type":"number","description":"Share (0..1) of influence carried by independent voices."},"targetOwnedCitations":{"type":"number"},"topType":{"anyOf":[{"type":"string"},{"type":"null"}]},"topSource":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["conversationCount","typeCount","sourceCount","brandShare","independentShare","targetOwnedCitations","topType","topSource"],"additionalProperties":false},"types":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"family":{"type":"string","enum":["brand_site","third_party_site"],"description":"A brand's own site, or a third-party site."},"share":{"type":"number","description":"Share (0..1) of total influence weight."},"conversationCount":{"type":"number"},"sourceCount":{"type":"number"}},"required":["id","label","family","share","conversationCount","sourceCount"],"additionalProperties":false}},"sources":{"$ref":"#/components/schemas/DiscoverySources"},"hiddenSourceCount":{"type":"number","description":"Domains beyond the listed ones."},"hiddenSourceShare":{"type":"number","description":"Combined share (0..1) of the hidden domains."},"scope":{"type":"object","properties":{"organizationId":{"type":"string"},"organizationName":{"type":"string"},"organizationSlug":{"anyOf":[{"type":"string"},{"type":"null"}]},"campaignId":{"type":"string"},"campaignName":{"type":"string"},"dispatchId":{"type":"string"},"sequenceNumber":{"type":"number"},"status":{"type":"string"},"triggeredAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"resolution":{"type":"string","enum":["dispatch","campaign","query","latest"]}},"required":["organizationId","organizationName","organizationSlug","campaignId","campaignName","dispatchId","sequenceNumber","status","triggeredAt","completedAt","resolution"],"additionalProperties":false,"description":"The newest run that measured a conversation of the map's window."}},"required":["summary","types","sources","hiddenSourceCount","hiddenSourceShare","scope"],"additionalProperties":false},{"type":"null"}],"description":"Null unless `scope.state` is `ready`."}},"required":["scope","map"],"additionalProperties":false},"DiscoverySourceMapsGetV2Response":{"type":"object","properties":{"scope":{"$ref":"#/components/schemas/DiscoveryScope"},"map":{"anyOf":[{"type":"object","properties":{"summary":{"type":"object","properties":{"conversationCount":{"type":"number"},"typeCount":{"type":"number"},"sourceCount":{"type":"number"},"brandShare":{"type":"number","description":"Share (0..1) of influence carried by brand-owned pages."},"independentShare":{"type":"number","description":"Share (0..1) of influence carried by independent voices."},"targetOwnedCitations":{"type":"number"},"topType":{"anyOf":[{"type":"string"},{"type":"null"}]},"topSource":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["conversationCount","typeCount","sourceCount","brandShare","independentShare","targetOwnedCitations","topType","topSource"],"additionalProperties":false},"types":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"family":{"type":"string","enum":["brand_site","third_party_site"],"description":"A brand's own site, or a third-party site."},"share":{"type":"number","description":"Share (0..1) of total influence weight."},"conversationCount":{"type":"number"},"sourceCount":{"type":"number"}},"required":["id","label","family","share","conversationCount","sourceCount"],"additionalProperties":false}},"sources":{"$ref":"#/components/schemas/DiscoverySources"},"hiddenSourceCount":{"type":"number","description":"Domains beyond the listed ones."},"hiddenSourceShare":{"type":"number","description":"Combined share (0..1) of the hidden domains."}},"required":["summary","types","sources","hiddenSourceCount","hiddenSourceShare"],"additionalProperties":false},{"type":"null"}],"description":"Null unless `scope.state` is `ready`."}},"required":["scope","map"],"additionalProperties":false},"DiscoverySourceMapsGetV3Response":{"type":"object","properties":{"scope":{"$ref":"#/components/schemas/DiscoveryScope"},"map":{"anyOf":[{"type":"object","properties":{"summary":{"type":"object","properties":{"conversationCount":{"type":"number"},"typeCount":{"type":"number"},"sourceCount":{"type":"number"},"brandShare":{"type":"number","description":"Share (0..1) of influence carried by brand-owned pages."},"independentShare":{"type":"number","description":"Share (0..1) of influence carried by independent voices."},"targetOwnedCitations":{"type":"number"},"topType":{"anyOf":[{"type":"string"},{"type":"null"}]},"topSource":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["conversationCount","typeCount","sourceCount","brandShare","independentShare","targetOwnedCitations","topType","topSource"],"additionalProperties":false},"types":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"family":{"type":"string","enum":["brand_site","third_party_site"],"description":"A brand's own site, or a third-party site."},"share":{"type":"number","description":"Share (0..1) of total influence weight."},"conversationCount":{"type":"number"},"sourceCount":{"type":"number"}},"required":["id","label","family","share","conversationCount","sourceCount"],"additionalProperties":false}},"sources":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"domain":{"type":"string"},"label":{"type":"string"},"typeId":{"type":"string","description":"The source type node the domain flows into."},"share":{"type":"number","description":"Share (0..1) of total influence weight."},"conversationCount":{"type":"number"},"isOwned":{"type":"boolean","description":"True when the domain is the campaign brand's own."},"icon":{"anyOf":[{"type":"object","properties":{"faviconUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"faviconFallbackLabel":{"anyOf":[{"type":"string"},{"type":"null"}]},"faviconTone":{"type":"string","enum":["dark","light","mixed","unknown"]},"faviconTransparent":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"faviconNeedsLightBackplate":{"type":"boolean"},"faviconNeedsDarkBackplate":{"type":"boolean"},"brandColor":{"description":"The campaign's assigned color token for this brand.","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["faviconUrl","faviconFallbackLabel","faviconTone","faviconTransparent","faviconNeedsLightBackplate","faviconNeedsDarkBackplate"],"additionalProperties":false},{"type":"null"}]}},"required":["id","domain","label","typeId","share","conversationCount","isOwned","icon"],"additionalProperties":false},"description":"Top domains across every type, ranked by influence share."},"hiddenSourceCount":{"type":"number","description":"Domains beyond the listed ones."},"hiddenSourceShare":{"type":"number","description":"Combined share (0..1) of the hidden domains."}},"required":["summary","types","sources","hiddenSourceCount","hiddenSourceShare"],"additionalProperties":false},{"type":"null"}],"description":"Null unless `scope.state` is `ready`."}},"required":["scope","map"],"additionalProperties":false},"DiscoveryMarketMapsGetResponse":{"type":"object","properties":{"scope":{"$ref":"#/components/schemas/DiscoveryScope2"},"map":{"$ref":"#/components/schemas/DiscoveryMap"}},"required":["scope","map"],"additionalProperties":false},"DiscoveryMarketMapsGetV2Response":{"type":"object","properties":{"scope":{"$ref":"#/components/schemas/DiscoveryScope"},"map":{"$ref":"#/components/schemas/DiscoveryMap"}},"required":["scope","map"],"additionalProperties":false},"DiscoveryStoreMapsGetV4Response":{"type":"object","properties":{"scope":{"$ref":"#/components/schemas/DiscoveryScope"},"map":{"anyOf":[{"type":"object","properties":{"state":{"type":"string","enum":["ready","partial","unmappable","no_results"]},"targetKind":{"type":"string","const":"physical_locations"},"brandUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The campaign's website."},"sites":{"type":"array","items":{"type":"object","properties":{"locationKey":{"type":"string"},"ordinal":{"type":"number"},"label":{"type":"string"},"storeId":{"anyOf":[{"type":"string"},{"type":"null"}]},"street":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"region":{"anyOf":[{"type":"string"},{"type":"null"}]},"postalCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"coordinateSource":{"anyOf":[{"type":"string","enum":["campaign_premise","verified_permanent_geocode"]},{"type":"null"}]},"unplacedReason":{"anyOf":[{"type":"string","enum":["no_coordinates","conflicting_verified_records"]},{"type":"null"}],"description":"Why the map cannot place the store; null whenever it has coordinates."},"googlePlaceId":{"description":"The Google listing the store was picked from at setup.","anyOf":[{"type":"string"},{"type":"null"}]},"storeState":{"description":"removed once a settings Save stopped measuring the store (its results before then stay); setting_up or failed while a store a Save added sets up; active otherwise.","type":"string","enum":["active","setting_up","failed","removed"]},"removedAt":{"description":"When a settings Save stopped measuring the store.","anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"assignedCustomers":{"type":"number"},"totalConversations":{"type":"number"},"mentioned":{"type":"number"},"won":{"type":"number"},"brandSharePct":{"type":"number"},"brandWinRatePct":{"type":"number"},"positive":{"type":"number"},"negative":{"type":"number"},"positiveSentimentPct":{"type":"number"},"negativeSentimentPct":{"type":"number"},"revenueInfluencedUsd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Null unless the read carries the target brand's revenue."},"revenueInfluenceableUsd":{"anyOf":[{"type":"number"},{"type":"null"}]},"revenueEligibleCustomerCount":{"type":"number"},"change":{"anyOf":[{"type":"object","properties":{"brandSharePts":{"anyOf":[{"type":"number"},{"type":"null"}]},"brandWinRatePts":{"anyOf":[{"type":"number"},{"type":"null"}]},"revenueInfluencedUsd":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["brandSharePts","brandWinRatePts","revenueInfluencedUsd"],"additionalProperties":false,"description":"The store's as-of value minus its value in the window that ends 30 days before the as-of day; each null when either window holds no reading."},{"type":"null"}]}},"required":["locationKey","ordinal","label","storeId","street","city","region","postalCode","country","latitude","longitude","coordinateSource","unplacedReason","assignedCustomers","totalConversations","mentioned","won","brandSharePct","brandWinRatePct","positive","negative","positiveSentimentPct","negativeSentimentPct","revenueInfluencedUsd","revenueInfluenceableUsd","revenueEligibleCustomerCount"],"additionalProperties":false}},"totalPremises":{"type":"number"},"coordinateReadyPremises":{"type":"number"},"failedPremises":{"type":"number"},"analysisAssignedPremises":{"type":"number"},"unassignedCustomers":{"type":"number"},"totalConversations":{"type":"number"},"segments":{"type":"array","items":{"type":"object","properties":{"axis":{"type":"string","enum":["audience","channel","market","age","householdIncome","education","lifeStage","areaType","companySize","buyerRole","seniority","occupation","job","triggerType","intentStage","language","gender","product","engine","competitor","topic","sentiment","store","customer"],"description":"A pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or one `store` or `customer`."},"id":{"type":"string","minLength":1,"maxLength":300,"description":"The member's id on that axis, as `discovery.segment-options.get` lists it."}},"required":["axis","id"],"additionalProperties":false},"description":"The segments every figure was narrowed to, ANDed; empty is the whole campaign."},"revenue":{"anyOf":[{"type":"object","properties":{"coverage":{"type":"object","properties":{"scope":{"description":"Location estimates may overlap markets.","type":"string","const":"locations"},"status":{"type":"string","enum":["none","partial","complete"]},"includedLineCount":{"type":"number"},"totalLineCount":{"type":"number"},"coveredConversationCount":{"type":"number"},"totalConversationCount":{"type":"number"},"coveragePct":{"type":"number"}},"required":["status","includedLineCount","totalLineCount","coveredConversationCount","totalConversationCount","coveragePct"],"additionalProperties":false},"totalInfluencedUsd":{"type":"number"},"totalInfluenceableUsd":{"type":"number"},"eligibleCustomerCount":{"type":"number"},"unassignedInfluencedUsd":{"type":"number","description":"Dollars whose customers bind to no configured store."}},"required":["coverage","totalInfluencedUsd","totalInfluenceableUsd","eligibleCustomerCount","unassignedInfluencedUsd"],"additionalProperties":false},{"type":"null"}],"description":"Null under a competitor lens or when no product (revenue line) with market assumptions covers the campaign."}},"required":["state","targetKind","brandUrl","sites","totalPremises","coordinateReadyPremises","failedPremises","analysisAssignedPremises","unassignedCustomers","totalConversations","segments","revenue"],"additionalProperties":false},{"type":"null"}],"description":"Null unless `scope.state` is `ready`."}},"required":["scope","map"],"additionalProperties":false},"DiscoveryStoreMapChangesGetResponse":{"type":"object","properties":{"scope":{"$ref":"#/components/schemas/DiscoveryScope2"},"changes":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"object","properties":{"brandSharePts":{"anyOf":[{"type":"number"},{"type":"null"}]},"brandWinRatePts":{"anyOf":[{"type":"number"},{"type":"null"}]},"revenueInfluencedUsd":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["brandSharePts","brandWinRatePts","revenueInfluencedUsd"],"additionalProperties":false,"description":"The store's as-of value minus its value in the window that ends 30 days before the as-of day; each null when either window holds no reading."},"description":"How each store moved since 30 days before the as-of day, by location key."},{"type":"null"}],"description":"Null unless `scope.state` is `ready`."}},"required":["scope","changes"],"additionalProperties":false},"DiscoveryStoreMapChangesGetV2Response":{"type":"object","properties":{"scope":{"$ref":"#/components/schemas/DiscoveryScope"},"changes":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"object","properties":{"brandSharePts":{"anyOf":[{"type":"number"},{"type":"null"}]},"brandWinRatePts":{"anyOf":[{"type":"number"},{"type":"null"}]},"revenueInfluencedUsd":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["brandSharePts","brandWinRatePts","revenueInfluencedUsd"],"additionalProperties":false,"description":"The store's as-of value minus its value in the window that ends 30 days before the as-of day; each null when either window holds no reading."},"description":"How each store moved since 30 days before the as-of day, by location key."},{"type":"null"}],"description":"Null unless `scope.state` is `ready`."}},"required":["scope","changes"],"additionalProperties":false},"DiscoveryBrandIconsGetResponse":{"type":"object","properties":{"icons":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/DiscoveryIcon"},"description":"Favicon identity keyed by normalized brand name (trimmed, spaces collapsed, lowercased). A brand with no resolved favicon carries its initials fallback."}},"required":["icons"],"additionalProperties":false},"DiscoveryBrandIconsGetV2Response":{"type":"object","properties":{"icons":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"object","properties":{"faviconUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"faviconFallbackLabel":{"anyOf":[{"type":"string"},{"type":"null"}]},"faviconTone":{"type":"string","enum":["dark","light","mixed","unknown"]},"faviconTransparent":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"faviconNeedsLightBackplate":{"type":"boolean"},"faviconNeedsDarkBackplate":{"type":"boolean"},"brandColor":{"description":"The campaign's assigned color token for this brand.","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["faviconUrl","faviconFallbackLabel","faviconTone","faviconTransparent","faviconNeedsLightBackplate","faviconNeedsDarkBackplate"],"additionalProperties":false},"description":"Favicon identity keyed by normalized brand name (trimmed, spaces collapsed, lowercased). A brand with no resolved favicon carries its initials fallback."}},"required":["icons"],"additionalProperties":false},"DiscoveryReportRowsListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"values":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}]},"description":"Keyed by the selected columns; counts are numbers, shares and rates percents."},"customerKey":{"description":"The customer a `conversations` row belongs to; absent or null otherwise.","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","values"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"scope":{"$ref":"#/components/schemas/DiscoveryScope2"},"totalCount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Rows the filters and query keep; null unless `scope.state` is `ready`."},"unfilteredRowCount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Rows before filters and query; null unless `scope.state` is `ready`."}},"required":["data","nextCursor","scope","totalCount","unfilteredRowCount"],"additionalProperties":false},"DiscoveryReportRowsListV2Response":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"values":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}]},"description":"Keyed by the selected columns; counts are numbers, shares and rates percents."},"customerKey":{"description":"The customer a `conversations` row belongs to; absent or null otherwise.","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","values"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"scope":{"$ref":"#/components/schemas/DiscoveryScope"},"totalCount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Rows the filters and query keep; null unless `scope.state` is `ready`."},"unfilteredRowCount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Rows before filters and query; null unless `scope.state` is `ready`."}},"required":["data","nextCursor","scope","totalCount","unfilteredRowCount"],"additionalProperties":false},"DiscoveryConversationPreviewsListResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DiscoveryData"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"scope":{"$ref":"#/components/schemas/DiscoveryScope2"}},"required":["data","nextCursor","scope"],"additionalProperties":false},"DiscoveryConversationPreviewsListV2Response":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DiscoveryData"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"scope":{"$ref":"#/components/schemas/DiscoveryScope"}},"required":["data","nextCursor","scope"],"additionalProperties":false},"DiscoveryConversationPreviewsListV3Response":{"type":"object","properties":{"data":{"maxItems":12,"type":"array","items":{"type":"object","properties":{"customerId":{"type":"string"},"customerName":{"type":"string"},"customerSubtitle":{"type":"string","description":"The customer's job title, else their age; empty when neither is known."},"conversation":{"type":"object","properties":{"id":{"type":"string"},"campaignId":{"type":"string"},"campaignName":{"type":"string"},"engine":{"type":"string","description":"The assistant's name, e.g. ChatGPT."},"engineId":{"type":"string","description":"The assistant's provider id, e.g. openai."},"occurredAt":{"type":"string","description":"ISO timestamp the conversation started."},"scoring":{"anyOf":[{"type":"object","properties":{"brands":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"color":{"anyOf":[{"type":"string"},{"type":"null"}]},"role":{"type":"string","enum":["target","competitor","other"]}},"required":["id","name","color","role"],"additionalProperties":false}}},"required":["brands"],"additionalProperties":false},{"type":"null"}],"description":"The brands the conversation named, in order; null when it named none."},"turns":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string","enum":["user","assistant"],"description":"`user` is the customer; `assistant` the AI."},"body":{"type":"string"},"at":{"description":"ISO timestamp, when the transcript kept one.","anyOf":[{"type":"string"},{"type":"null"}]},"label":{"description":"The speaker: the customer's name or the assistant's.","type":"string"},"sources":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"siteName":{"anyOf":[{"type":"string"},{"type":"null"}]},"faviconUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"faviconTone":{"anyOf":[{"type":"string","enum":["dark","light","mixed","unknown"]},{"type":"null"}]},"faviconTransparent":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"faviconNeedsLightBackplate":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"faviconNeedsDarkBackplate":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["url"],"additionalProperties":false}},"searchQueries":{"type":"array","items":{"type":"string"}}},"required":["id","role","body"],"additionalProperties":false},"description":"The conversation's first turns."}},"required":["id","campaignId","campaignName","engine","engineId","occurredAt","scoring","turns"],"additionalProperties":false}},"required":["customerId","customerName","customerSubtitle","conversation"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"scope":{"$ref":"#/components/schemas/DiscoveryScope"}},"required":["data","nextCursor","scope"],"additionalProperties":false},"DiscoveryConversationsListResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DiscoveryData2"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"scope":{"$ref":"#/components/schemas/DiscoveryScope2"},"totalCount":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}],"description":"Conversations the filters and search keep; null unless `scope.state` is `ready`."}},"required":["data","nextCursor","scope","totalCount"],"additionalProperties":false},"DiscoveryConversationsListV2Response":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DiscoveryData2"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"scope":{"$ref":"#/components/schemas/DiscoveryScope"},"totalCount":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}],"description":"Conversations the filters and search keep; null unless `scope.state` is `ready`."}},"required":["data","nextCursor","scope","totalCount"],"additionalProperties":false},"DiscoveryConversationsExportV3Response":{"type":"object","properties":{"filename":{"type":"string","minLength":1,"description":"Suggested file name for saving the bytes"},"contentType":{"type":"string","minLength":1},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Short-lived presigned URL that GETs the bytes; null when this deployment cannot sign the object"},"expiresAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}],"description":"When url stops working (minutes after the call); null with url"},"exportId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"This export's id, recorded on its audit row."},"rowCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Conversations in the file."},"format":{"type":"string","enum":["csv","jsonl","markdown"]},"scope":{"$ref":"#/components/schemas/DiscoveryScope"}},"required":["filename","contentType","byteLength","url","expiresAt","exportId","rowCount","format","scope"],"additionalProperties":false},"DiscoveryReportTablesExportResponse":{"type":"object","properties":{"filename":{"type":"string","minLength":1,"description":"Suggested file name for saving the bytes"},"contentType":{"type":"string","minLength":1},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Short-lived presigned URL that GETs the bytes; null when this deployment cannot sign the object"},"expiresAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}],"description":"When url stops working (minutes after the call); null with url"},"exportId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"This export's id, recorded on its audit row."},"rowCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Table rows in the file, after the header."},"format":{"type":"string","enum":["csv"]},"dimension":{"type":"string","enum":["revenue","audiences","channels","locations","topics","competitors","engines","sources","conversations","customers","win-reasons","loss-reasons","decision-factors","positive-sentiment","negative-sentiment"]}},"required":["filename","contentType","byteLength","url","expiresAt","exportId","rowCount","format","dimension"],"additionalProperties":false},"DiscoveryReportTablesExportV2Response":{"type":"object","properties":{"filename":{"type":"string","minLength":1,"description":"Suggested file name for saving the bytes"},"contentType":{"type":"string","minLength":1},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Short-lived presigned URL that GETs the bytes; null when this deployment cannot sign the object"},"expiresAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}],"description":"When url stops working (minutes after the call); null with url"},"exportId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"This export's id, recorded on its audit row."},"rowCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Table rows in the file, after the header."},"format":{"type":"string","enum":["csv"]},"dimension":{"type":"string","enum":["revenue","audiences","channels","locations","topics","competitors","engines","sources","conversations","customers","win-reasons","loss-reasons","decision-factors","positive-sentiment","negative-sentiment"]},"scope":{"$ref":"#/components/schemas/DiscoveryScope"}},"required":["filename","contentType","byteLength","url","expiresAt","exportId","rowCount","format","dimension","scope"],"additionalProperties":false},"DiscoveryStoreCustomerMapsGetResponse":{"type":"object","properties":{"customers":{"$ref":"#/components/schemas/DiscoveryCustomers"}},"required":["customers"],"additionalProperties":false},"DiscoveryStoreCustomerMapsGetV2Response":{"type":"object","properties":{"scope":{"$ref":"#/components/schemas/DiscoveryScope"},"customers":{"anyOf":[{"$ref":"#/components/schemas/DiscoveryCustomers"},{"type":"null"}],"description":"Null unless `scope.state` is `ready`."}},"required":["scope","customers"],"additionalProperties":false},"DiscoveryStoreCustomersGetResponse":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/DiscoveryCustomer"}},"required":["customer"],"additionalProperties":false},"DiscoveryStoreCustomersGetV2Response":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/DiscoveryCustomer"}},"required":["customer"],"additionalProperties":false},"DiscoveryCampaignSetupsRetryRequest":{"type":"object","properties":{"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The campaign whose setup to retry."}},"required":["campaignId"],"additionalProperties":false},"DiscoveryCampaignSetupsRetryResponse":{"type":"object","properties":{"runId":{"type":"string","description":"The run's id; read its progress with platform.runs.get."},"entryId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The campaign entry this request started; read its progress with campaigns.campaign-entries.get.v1."},"status":{"type":"string","const":"started"},"campaignId":{"type":"string"}},"required":["runId","entryId","status","campaignId"],"additionalProperties":false},"DiscoveryLocationReportsGetResponse":{"type":"object","properties":{"scope":{"$ref":"#/components/schemas/DiscoveryScope2"},"report":{"anyOf":[{"type":"object","properties":{"precisionTargetMarginOfErrorPct":{"type":"number"},"panelEligibleCustomerCount":{"description":"The unsegmented campaign-wide panel total.","type":"number"},"locations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["country","admin1","city","postcode"]},"name":{"type":"string"},"shortName":{"type":"string"},"color":{"type":"string"},"parentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"childIds":{"type":"array","items":{"type":"string"}},"level":{"type":"number","enum":[1,2,3,4],"description":"1 country → 4 postcode."},"countryCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"admin1Code":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"postcode":{"anyOf":[{"type":"string"},{"type":"null"}]},"map":{"oneOf":[{"type":"object","properties":{"mode":{"type":"string","const":"region"},"regionCode":{"type":"string"},"resolution":{"type":"string","enum":["countries","provinces","postal"]}},"required":["mode","regionCode","resolution"],"additionalProperties":false},{"type":"object","properties":{"mode":{"type":"string","const":"marker"},"latitude":{"type":"number"},"longitude":{"type":"number"},"regionCode":{"type":"string"},"resolution":{"type":"string","enum":["countries","provinces","postal"]}},"required":["mode","latitude","longitude"],"additionalProperties":false},{"type":"object","properties":{"mode":{"type":"string","const":"none"}},"required":["mode"],"additionalProperties":false}],"description":"How a map draws the place: a boundary region, a point, or not at all."},"totalConversations":{"type":"number"},"mentioned":{"type":"number","description":"Conversations that mentioned the brand."},"won":{"type":"number","description":"Conversations the brand won."},"brandShare":{"type":"number"},"winRate":{"type":"number"},"vsPortfolioPts":{"type":"number","description":"Brand win rate minus the campaign's all-up brand win rate, in points."},"topCompetitor":{"anyOf":[{"type":"string"},{"type":"null"}]},"isHomeBase":{"type":"boolean"},"geoRegion":{"anyOf":[{"type":"string"},{"type":"null"}]},"geoResolution":{"anyOf":[{"type":"string","enum":["countries","provinces","postal"]},{"type":"null"}]},"revenueInfluencedUsd":{"description":"Target revenue influenced; null when revenue was not read.","anyOf":[{"type":"number"},{"type":"null"}]},"eligibleCustomerCount":{"type":"number"},"brandShareDelta":{"type":"number"},"winRateDelta":{"type":"number"},"revenueEligibleCustomerCount":{"type":"number"}},"required":["id","type","name","shortName","color","parentId","childIds","level","countryCode","admin1Code","city","postcode","map","totalConversations","mentioned","won","brandShare","winRate","vsPortfolioPts","brandShareDelta","winRateDelta"],"additionalProperties":false},"description":"Places in tree order: each parent before its children."},"drivers":{"type":"array","items":{"type":"object","properties":{"locationId":{"type":"string"},"kind":{"type":"string","enum":["win","loss"]},"label":{"type":"string","description":"The reason, as the model wrote it."},"count":{"type":"number","description":"Conversations citing the reason."},"eligibleCustomerCount":{"type":"number"},"series":{"type":"array","items":{"type":"object","properties":{"month":{"type":"string"},"value":{"type":"number"}},"required":["month","value"],"additionalProperties":false}}},"required":["locationId","kind","label","count"],"additionalProperties":false}},"conversationCount":{"type":"number"},"portfolioShare":{"type":"number"},"portfolioWinRate":{"type":"number"},"revenueCoverage":{"type":"object","properties":{"scope":{"description":"Location estimates may overlap markets.","type":"string","const":"locations"},"status":{"type":"string","enum":["none","partial","complete"]},"includedLineCount":{"type":"number"},"totalLineCount":{"type":"number"},"coveredConversationCount":{"type":"number"},"totalConversationCount":{"type":"number"},"coveragePct":{"type":"number"}},"required":["status","includedLineCount","totalLineCount","coveredConversationCount","totalConversationCount","coveragePct"],"additionalProperties":false}},"required":["locations","drivers","conversationCount","portfolioShare","portfolioWinRate","revenueCoverage"],"additionalProperties":false},{"type":"null"}],"description":"Null unless `scope.state` is `ready`."}},"required":["scope","report"],"additionalProperties":false},"DiscoveryLocationReportsGetV2Response":{"type":"object","properties":{"scope":{"$ref":"#/components/schemas/DiscoveryScope"},"report":{"anyOf":[{"type":"object","properties":{"locations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["country","admin1","city","postcode"]},"name":{"type":"string"},"shortName":{"type":"string"},"color":{"type":"string"},"parentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"childIds":{"type":"array","items":{"type":"string"}},"level":{"type":"number","enum":[1,2,3,4],"description":"1 country → 4 postcode."},"countryCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"admin1Code":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"postcode":{"anyOf":[{"type":"string"},{"type":"null"}]},"map":{"oneOf":[{"type":"object","properties":{"mode":{"type":"string","const":"region"},"regionCode":{"type":"string"},"resolution":{"type":"string","enum":["countries","provinces","postal"]}},"required":["mode","regionCode","resolution"],"additionalProperties":false},{"type":"object","properties":{"mode":{"type":"string","const":"marker"},"latitude":{"type":"number"},"longitude":{"type":"number"},"regionCode":{"type":"string"},"resolution":{"type":"string","enum":["countries","provinces","postal"]}},"required":["mode","latitude","longitude"],"additionalProperties":false},{"type":"object","properties":{"mode":{"type":"string","const":"none"}},"required":["mode"],"additionalProperties":false}],"description":"How a map draws the place: a boundary region, a point, or not at all."},"totalConversations":{"type":"number","description":"The as-of window's conversations of the place's customers."},"mentioned":{"type":"number","description":"Conversations that mentioned the brand."},"won":{"type":"number","description":"Conversations the brand won."},"brandShare":{"type":"number"},"winRate":{"type":"number"},"vsPortfolioPts":{"type":"number","description":"Brand win rate minus the campaign's all-up brand win rate, in points."},"topCompetitor":{"anyOf":[{"type":"string"},{"type":"null"}]},"isHomeBase":{"type":"boolean"},"geoRegion":{"anyOf":[{"type":"string"},{"type":"null"}]},"geoResolution":{"anyOf":[{"type":"string","enum":["countries","provinces","postal"]},{"type":"null"}]},"revenueInfluencedUsd":{"description":"Target revenue influenced; null when revenue was not read.","anyOf":[{"type":"number"},{"type":"null"}]},"brandShareDelta":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The value minus its value in the window that ends 30 days before the as-of day, in points; null when that window holds none of the place's conversations."},"winRateDelta":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The value minus its value in the window that ends 30 days before the as-of day, in points; null when that window holds none of the place's conversations."}},"required":["id","type","name","shortName","color","parentId","childIds","level","countryCode","admin1Code","city","postcode","map","totalConversations","mentioned","won","brandShare","winRate","vsPortfolioPts","brandShareDelta","winRateDelta"],"additionalProperties":false},"description":"Places in tree order: each parent before its children."},"drivers":{"type":"array","items":{"type":"object","properties":{"locationId":{"type":"string"},"kind":{"type":"string","enum":["win","loss"]},"label":{"type":"string","description":"The reason, as the model wrote it."},"count":{"type":"number","description":"The as-of window's conversations that gave it."}},"required":["locationId","kind","label","count"],"additionalProperties":false}},"conversationCount":{"type":"number","description":"The as-of window's conversations in scope."},"portfolioShare":{"type":"number"},"portfolioWinRate":{"type":"number"},"revenueCoverage":{"type":"object","properties":{"scope":{"description":"Location estimates may overlap markets.","type":"string","const":"locations"},"status":{"type":"string","enum":["none","partial","complete"]},"includedLineCount":{"type":"number"},"totalLineCount":{"type":"number"},"coveredConversationCount":{"type":"number"},"totalConversationCount":{"type":"number"},"coveragePct":{"type":"number"}},"required":["status","includedLineCount","totalLineCount","coveredConversationCount","totalConversationCount","coveragePct"],"additionalProperties":false}},"required":["locations","drivers","conversationCount","portfolioShare","portfolioWinRate","revenueCoverage"],"additionalProperties":false,"description":"Every value as of the results window's as-of day."},{"type":"null"}],"description":"Null unless `scope.state` is `ready`."}},"required":["scope","report"],"additionalProperties":false},"DiscoveryWebsiteIconsResolveResponse":{"type":"object","properties":{"iconUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The stored icon's public object URL; null when the site has none or its check has not finished."}},"required":["iconUrl"],"additionalProperties":false},"DiscoveryWebsiteIconsResolveV2Response":{"type":"object","properties":{"faviconUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"faviconFallbackLabel":{"anyOf":[{"type":"string"},{"type":"null"}]},"faviconTone":{"type":"string","enum":["dark","light","mixed","unknown"]},"faviconTransparent":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"faviconNeedsLightBackplate":{"type":"boolean"},"faviconNeedsDarkBackplate":{"type":"boolean"}},"required":["faviconUrl","faviconFallbackLabel","faviconTone","faviconTransparent","faviconNeedsLightBackplate","faviconNeedsDarkBackplate"],"additionalProperties":false,"description":"The host registry's stored icon (a public object URL) with its tone and backplates, else a null faviconUrl and the label its monogram draws, when the site has no icon or its check has not finished."},"DiscoveryWebsiteSuggestionsSearchResponse":{"type":"object","properties":{"suggestions":{"type":"array","items":{"type":"object","properties":{"host":{"type":"string","description":"The site's bare host: lowercase, with no scheme and no www."},"displayName":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name its business profile or brand gives it; null when none does."}},"required":["host","displayName"],"additionalProperties":false},"description":"The matching sites, best first."}},"required":["suggestions"],"additionalProperties":false},"DiscoveryProfileCompetitorWebsitesGetResponse":{"type":"object","properties":{"competitors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The competitor's name, as the profile gives it."},"host":{"type":"string","description":"The competitor's site: lowercase, with no scheme and no www."}},"required":["name","host"],"additionalProperties":false},"description":"The profile's competitors with a site, in the profile's order."}},"required":["competitors"],"additionalProperties":false},"DiscoveryCampaignsLaunchRequest":{"type":"object","properties":{"form":{"$ref":"#/components/schemas/DiscoveryForm"},"expectedMonthlyPriceCents":{"description":"The Analytics monthly price the caller reviewed, in cents; a launch whose current price differs is refused (reason PRICE_CHANGED).","type":"integer","minimum":0,"maximum":9007199254740991},"replacesCampaignId":{"description":"Refused: a campaign's settings change in place with discovery.campaign-settings.update.v2. Omit it to start a new campaign.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["form"],"additionalProperties":false,"deprecated":true},"DiscoveryCampaignsLaunchResponse":{"type":"object","properties":{"runId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The billing run the launch dispatched, or null: campaign setup is a background workflow, not a billing run, and bills its conversations as they are admitted."},"status":{"type":"string","enum":["setup_started"],"description":"`setup_started`: the campaign exists and its setup runs in the background (a retry of a launch already started answers the same)."},"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The started campaign. Its first entry is admitted once its setup finishes, after this response; list its entries with campaigns.campaign-entries.list.v1."}},"required":["runId","status","campaignId"],"additionalProperties":false},"DiscoveryCampaignsLaunchV2Request":{"type":"object","properties":{"form":{"$ref":"#/components/schemas/DiscoveryForm"},"expectedMonthlyPriceCents":{"description":"The Analytics monthly price the caller reviewed, in cents; a launch whose current price differs is refused (reason PRICE_CHANGED).","type":"integer","minimum":0,"maximum":9007199254740991}},"required":["form"],"additionalProperties":false},"DiscoveryCampaignsLaunchV2Response":{"type":"object","properties":{"runId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The billing run the launch dispatched, or null: campaign setup is a background workflow, not a billing run, and bills its conversations as they are admitted."},"status":{"type":"string","enum":["setup_started"],"description":"`setup_started`: the campaign exists and its setup runs in the background (a retry of a launch already started answers the same)."},"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The started campaign. Its first entry is admitted once its setup finishes, after this response; list its entries with campaigns.campaign-entries.list.v1."}},"required":["runId","status","campaignId"],"additionalProperties":false},"DiscoveryCampaignsUpdateRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The Discovery campaign to rename."},"name":{"type":"string","minLength":1,"maxLength":120,"description":"The campaign's new name."}},"required":["id","name"],"additionalProperties":false,"deprecated":true},"DiscoveryCampaignsUpdateResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},"DiscoveryAdScopesGetResponse":{"type":"object","properties":{"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"campaignName":{"type":"string"},"lossReason":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"The named loss reason with its report label; null when none was named"}},"required":["campaignId","campaignName","lossReason"],"additionalProperties":false},"DiscoveryCampaignCustomersListV3Response":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DiscoveryData3"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"totalCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"selectedCustomerIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"audienceTypes":{"type":"array","items":{"type":"string","enum":["b2b","b2c","prosumer","mixed"]},"description":"The audience types of the customers this list draws from, each read as a Buyer type (b2c is B2C; b2b, prosumer and mixed are B2B); a column only another Buyer type carries is not a column."}},"required":["data","nextCursor","totalCount","selectedCustomerIds","audienceTypes"],"additionalProperties":false},"DiscoveryCampaignCustomersListV4Response":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DiscoveryData4"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"totalCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"selectedCustomerIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"audienceTypes":{"type":"array","items":{"type":"string","enum":["b2b","b2c","prosumer","mixed"]},"description":"The audience types of the customers this list draws from, each read as a Buyer type (b2c is B2C; b2b, prosumer and mixed are B2B); a column only another Buyer type carries is not a column."}},"required":["data","nextCursor","totalCount","selectedCustomerIds","audienceTypes"],"additionalProperties":false},"DiscoveryRosterMembersListV3Response":{"type":"object","properties":{"data":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customerKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"type":"string"},"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"businessProfileKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"profileName":{"anyOf":[{"type":"string"},{"type":"null"}]},"profileUrl":{"type":"string"},"profileBusinessSummary":{"anyOf":[{"type":"string"},{"type":"null"}]},"source":{"type":"string","enum":["generated","manual","connected"]},"poolStatus":{"type":"string","enum":["active","retired"]},"retiredAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"forecastSeeded":{"type":"boolean"},"audiences":{"type":"array","items":{"type":"string"}},"systemAudiences":{"type":"array","items":{"type":"string"}},"userAudiences":{"type":"array","items":{"type":"string"}},"userAudienceIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"sources":{"type":"array","items":{"type":"string"}},"jobTitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"gender":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Gender"},"age":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Age"},"age.band":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Age band"},"language":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Language"},"location":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Location"},"market":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Market"},"areaType":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Area type"},"education":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Education"},"lifeStage":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Life stage"},"householdIncome":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Household income"},"householdIncome.band":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Income band"},"occupation":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Occupation"},"seniority":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Seniority"},"employer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Employer"},"companySize":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Company size"},"companySize.band":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Size band"},"annualRevenue":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Annual revenue"},"buyerType":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Buyer type"},"audience":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Audience"},"product":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Product"},"channel":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Channel"},"buyerRole":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Buyer role"},"intentStage":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Intent stage"},"job":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Job to be done"},"triggerType":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Trigger type"},"trigger":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Trigger"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"generationRunId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"latestDiscoveryOutcome":{"$ref":"#/components/schemas/DiscoveryLatestDiscoveryOutcome"},"rosterMembershipId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sampledAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"When the customer joined the roster."},"removedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"removedByUserId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"membershipStatus":{"type":"string","enum":["current","removed","archived_in_pool"],"description":"`archived_in_pool` is on the roster but archived in Business."},"performance":{"type":"object","properties":{"totalConversations":{"type":"integer","minimum":0,"maximum":9007199254740991},"brandShareCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"brandWinCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"brandSharePct":{"type":"number"},"brandWinRatePct":{"type":"number"},"latestOutcome":{"$ref":"#/components/schemas/DiscoveryLatestDiscoveryOutcome"}},"required":["totalConversations","brandShareCount","brandWinCount","brandSharePct","brandWinRatePct","latestOutcome"],"additionalProperties":false,"description":"This campaign's conversations with the customer."}},"required":["id","customerKey","label","businessProfileId","businessProfileKey","profileName","profileUrl","profileBusinessSummary","source","poolStatus","retiredAt","forecastSeeded","audiences","systemAudiences","userAudiences","userAudienceIds","sources","jobTitle","gender","age","age.band","language","location","market","areaType","education","lifeStage","householdIncome","householdIncome.band","occupation","seniority","employer","companySize","companySize.band","annualRevenue","buyerType","audience","product","channel","buyerRole","intentStage","job","triggerType","trigger","createdAt","generationRunId","latestDiscoveryOutcome","rosterMembershipId","sampledAt","removedAt","removedByUserId","membershipStatus","performance"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"totalCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Customers the search and audiences keep."},"pageIndex":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"How many whole pages of this limit sort before the page answered."},"facetOptions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"},"label":{"type":"string"},"count":{"type":"integer","minimum":0,"maximum":9007199254740991},"kind":{"type":"string","enum":["source","system-audience","user-audience"]}},"required":["id","value","label","count","kind"],"additionalProperties":false},"description":"The audiences to narrow by."},"facetTotalCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"query":{"type":"string","description":"The search as the roster read it."},"editable":{"type":"boolean","description":"Whether the roster can change now."},"editBlockedReason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Why it cannot, when it cannot."},"audienceTypes":{"type":"array","items":{"type":"string","enum":["b2b","b2c","prosumer","mixed"]},"description":"The audience types of the customers this list draws from, each read as a Buyer type (b2c is B2C; b2b, prosumer and mixed are B2B); a column only another Buyer type carries is not a column."},"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"included":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Customers on the roster now."},"currentCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"removedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"archivedInPoolCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"status":{"type":"string","enum":["current","removed","all"]},"campaign":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"campaignKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","enum":["active","paused","archived","deleted"]},"changeable":{"type":"boolean","description":"Whether its status admits roster changes: active or paused."}},"required":["id","campaignKey","name","status","changeable"],"additionalProperties":false}},"required":["data","nextCursor","totalCount","pageIndex","facetOptions","facetTotalCount","query","editable","editBlockedReason","audienceTypes","campaignId","businessProfileId","included","currentCount","removedCount","archivedInPoolCount","status","campaign"],"additionalProperties":false},"DiscoveryRosterMembersListV4Response":{"type":"object","properties":{"data":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customerKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"type":"string"},"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"businessProfileKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"profileName":{"anyOf":[{"type":"string"},{"type":"null"}]},"profileUrl":{"type":"string"},"profileBusinessSummary":{"anyOf":[{"type":"string"},{"type":"null"}]},"source":{"type":"string","enum":["generated","manual","connected"]},"poolStatus":{"type":"string","enum":["active","retired"]},"retiredAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"forecastSeeded":{"type":"boolean"},"audiences":{"type":"array","items":{"type":"string"}},"systemAudiences":{"type":"array","items":{"type":"string"}},"userAudiences":{"type":"array","items":{"type":"string"}},"userAudienceIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"sources":{"type":"array","items":{"type":"string"}},"jobTitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"gender":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Gender"},"age":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Age"},"age.band":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Age band"},"language":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Language"},"location":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Location"},"market":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Market"},"areaType":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Area type"},"education":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Education"},"lifeStage":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Life stage"},"householdIncome":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Household income"},"householdIncome.band":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Income band"},"occupation":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Occupation"},"seniority":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Seniority"},"employer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Employer"},"companySize":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Company size"},"companySize.band":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Size band"},"annualRevenue":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Annual revenue"},"buyerType":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Buyer type"},"audience":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Audience"},"product":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Product"},"channel":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Channel"},"buyerRole":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Buyer role"},"intentStage":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Intent stage"},"job":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Job to be done"},"triggerType":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Trigger type"},"trigger":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Trigger"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"generationRunId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"latestDiscoveryOutcome":{"$ref":"#/components/schemas/DiscoveryItemLatestDiscoveryOutcome"},"rosterMembershipId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sampledAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"When the customer joined the roster."},"removedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"removedByUserId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"membershipStatus":{"type":"string","enum":["current","removed","archived_in_pool"],"description":"`archived_in_pool` is on the roster but archived in Business."},"performance":{"type":"object","properties":{"totalConversations":{"type":"integer","minimum":0,"maximum":9007199254740991},"brandShareCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"brandWinCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"brandSharePct":{"type":"number"},"brandWinRatePct":{"type":"number"},"latestOutcome":{"$ref":"#/components/schemas/DiscoveryItemLatestDiscoveryOutcome"}},"required":["totalConversations","brandShareCount","brandWinCount","brandSharePct","brandWinRatePct","latestOutcome"],"additionalProperties":false,"description":"This campaign's conversations with the customer."}},"required":["id","customerKey","label","businessProfileId","businessProfileKey","profileName","profileUrl","profileBusinessSummary","source","poolStatus","retiredAt","forecastSeeded","audiences","systemAudiences","userAudiences","userAudienceIds","sources","jobTitle","gender","age","age.band","language","location","market","areaType","education","lifeStage","householdIncome","householdIncome.band","occupation","seniority","employer","companySize","companySize.band","annualRevenue","buyerType","audience","product","channel","buyerRole","intentStage","job","triggerType","trigger","createdAt","generationRunId","latestDiscoveryOutcome","rosterMembershipId","sampledAt","removedAt","removedByUserId","membershipStatus","performance"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"totalCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Customers the search and audiences keep."},"pageIndex":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"How many whole pages of this limit sort before the page answered."},"facetOptions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"},"label":{"type":"string"},"count":{"type":"integer","minimum":0,"maximum":9007199254740991},"kind":{"type":"string","enum":["source","system-audience","user-audience"]}},"required":["id","value","label","count","kind"],"additionalProperties":false},"description":"The audiences to narrow by."},"facetTotalCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"query":{"type":"string","description":"The search as the roster read it."},"editable":{"type":"boolean","description":"Whether the roster can change now."},"editBlockedReason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Why it cannot, when it cannot."},"audienceTypes":{"type":"array","items":{"type":"string","enum":["b2b","b2c","prosumer","mixed"]},"description":"The audience types of the customers this list draws from, each read as a Buyer type (b2c is B2C; b2b, prosumer and mixed are B2B); a column only another Buyer type carries is not a column."},"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"included":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Customers on the roster now."},"currentCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"removedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"archivedInPoolCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"status":{"type":"string","enum":["current","removed","all"]},"campaign":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"campaignKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","enum":["active","paused","archived","deleted"]},"changeable":{"type":"boolean","description":"Whether its status admits roster changes: active or paused."}},"required":["id","campaignKey","name","status","changeable"],"additionalProperties":false}},"required":["data","nextCursor","totalCount","pageIndex","facetOptions","facetTotalCount","query","editable","editBlockedReason","audienceTypes","campaignId","businessProfileId","included","currentCount","removedCount","archivedInPoolCount","status","campaign"],"additionalProperties":false},"DiscoveryRosterCandidatesListV3Response":{"type":"object","properties":{"data":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customerKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"type":"string"},"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"businessProfileKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"profileName":{"anyOf":[{"type":"string"},{"type":"null"}]},"profileUrl":{"type":"string"},"profileBusinessSummary":{"anyOf":[{"type":"string"},{"type":"null"}]},"source":{"type":"string","enum":["generated","manual","connected"]},"poolStatus":{"type":"string","enum":["active","retired"]},"retiredAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"forecastSeeded":{"type":"boolean"},"audiences":{"type":"array","items":{"type":"string"}},"systemAudiences":{"type":"array","items":{"type":"string"}},"userAudiences":{"type":"array","items":{"type":"string"}},"userAudienceIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"sources":{"type":"array","items":{"type":"string"}},"jobTitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"gender":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Gender"},"age":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Age"},"age.band":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Age band"},"language":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Language"},"location":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Location"},"market":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Market"},"areaType":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Area type"},"education":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Education"},"lifeStage":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Life stage"},"householdIncome":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Household income"},"householdIncome.band":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Income band"},"occupation":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Occupation"},"seniority":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Seniority"},"employer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Employer"},"companySize":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Company size"},"companySize.band":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Size band"},"annualRevenue":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Annual revenue"},"buyerType":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Buyer type"},"audience":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Audience"},"product":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Product"},"channel":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Channel"},"buyerRole":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Buyer role"},"intentStage":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Intent stage"},"job":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Job to be done"},"triggerType":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Trigger type"},"trigger":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Trigger"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"generationRunId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"latestDiscoveryOutcome":{"$ref":"#/components/schemas/DiscoveryLatestDiscoveryOutcome"},"ineligibleReason":{"anyOf":[{"type":"string","enum":["deleted","archived","other_profile","forecast_customer","not_store_customer","other_store","not_forecast_customer","connected_not_ready","outside_audience","unavailable","already_on_campaign"]},{"type":"null"}],"description":"Why the customer cannot join this campaign; null when it can."}},"required":["id","customerKey","label","businessProfileId","businessProfileKey","profileName","profileUrl","profileBusinessSummary","source","poolStatus","retiredAt","forecastSeeded","audiences","systemAudiences","userAudiences","userAudienceIds","sources","jobTitle","gender","age","age.band","language","location","market","areaType","education","lifeStage","householdIncome","householdIncome.band","occupation","seniority","employer","companySize","companySize.band","annualRevenue","buyerType","audience","product","channel","buyerRole","intentStage","job","triggerType","trigger","createdAt","generationRunId","latestDiscoveryOutcome","ineligibleReason"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"totalCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Customers the search and audiences keep."},"pageIndex":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"How many whole pages of this limit sort before the page answered."},"facetOptions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"},"label":{"type":"string"},"count":{"type":"integer","minimum":0,"maximum":9007199254740991},"kind":{"type":"string","enum":["source","system-audience","user-audience"]}},"required":["id","value","label","count","kind"],"additionalProperties":false},"description":"The audiences to narrow by."},"facetTotalCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"query":{"type":"string","description":"The search as the roster read it."},"editable":{"type":"boolean","description":"Whether the roster can change now."},"editBlockedReason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Why it cannot, when it cannot."},"audienceTypes":{"type":"array","items":{"type":"string","enum":["b2b","b2c","prosumer","mixed"]},"description":"The audience types of the customers this list draws from, each read as a Buyer type (b2c is B2C; b2b, prosumer and mixed are B2B); a column only another Buyer type carries is not a column."},"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"included":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Customers on the roster now."}},"required":["data","nextCursor","totalCount","pageIndex","facetOptions","facetTotalCount","query","editable","editBlockedReason","audienceTypes","campaignId","included"],"additionalProperties":false},"DiscoveryRosterCandidatesListV4Response":{"type":"object","properties":{"data":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customerKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"type":"string"},"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"businessProfileKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"profileName":{"anyOf":[{"type":"string"},{"type":"null"}]},"profileUrl":{"type":"string"},"profileBusinessSummary":{"anyOf":[{"type":"string"},{"type":"null"}]},"source":{"type":"string","enum":["generated","manual","connected"]},"poolStatus":{"type":"string","enum":["active","retired"]},"retiredAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"forecastSeeded":{"type":"boolean"},"audiences":{"type":"array","items":{"type":"string"}},"systemAudiences":{"type":"array","items":{"type":"string"}},"userAudiences":{"type":"array","items":{"type":"string"}},"userAudienceIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"sources":{"type":"array","items":{"type":"string"}},"jobTitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"gender":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Gender"},"age":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Age"},"age.band":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Age band"},"language":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Language"},"location":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Location"},"market":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Market"},"areaType":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Area type"},"education":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Education"},"lifeStage":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Life stage"},"householdIncome":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Household income"},"householdIncome.band":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Income band"},"occupation":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Occupation"},"seniority":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Seniority"},"employer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Employer"},"companySize":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Company size"},"companySize.band":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Size band"},"annualRevenue":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Annual revenue"},"buyerType":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Buyer type"},"audience":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Audience"},"product":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Product"},"channel":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Channel"},"buyerRole":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Buyer role"},"intentStage":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Intent stage"},"job":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Job to be done"},"triggerType":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Trigger type"},"trigger":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Trigger"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"generationRunId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"latestDiscoveryOutcome":{"$ref":"#/components/schemas/DiscoveryItemLatestDiscoveryOutcome"},"ineligibleReason":{"anyOf":[{"type":"string","enum":["deleted","archived","other_profile","forecast_customer","not_store_customer","other_store","not_forecast_customer","connected_not_ready","outside_audience","unavailable","already_on_campaign"]},{"type":"null"}],"description":"Why the customer cannot join this campaign; null when it can."}},"required":["id","customerKey","label","businessProfileId","businessProfileKey","profileName","profileUrl","profileBusinessSummary","source","poolStatus","retiredAt","forecastSeeded","audiences","systemAudiences","userAudiences","userAudienceIds","sources","jobTitle","gender","age","age.band","language","location","market","areaType","education","lifeStage","householdIncome","householdIncome.band","occupation","seniority","employer","companySize","companySize.band","annualRevenue","buyerType","audience","product","channel","buyerRole","intentStage","job","triggerType","trigger","createdAt","generationRunId","latestDiscoveryOutcome","ineligibleReason"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"totalCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Customers the search and audiences keep."},"pageIndex":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"How many whole pages of this limit sort before the page answered."},"facetOptions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"},"label":{"type":"string"},"count":{"type":"integer","minimum":0,"maximum":9007199254740991},"kind":{"type":"string","enum":["source","system-audience","user-audience"]}},"required":["id","value","label","count","kind"],"additionalProperties":false},"description":"The audiences to narrow by."},"facetTotalCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"query":{"type":"string","description":"The search as the roster read it."},"editable":{"type":"boolean","description":"Whether the roster can change now."},"editBlockedReason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Why it cannot, when it cannot."},"audienceTypes":{"type":"array","items":{"type":"string","enum":["b2b","b2c","prosumer","mixed"]},"description":"The audience types of the customers this list draws from, each read as a Buyer type (b2c is B2C; b2b, prosumer and mixed are B2B); a column only another Buyer type carries is not a column."},"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"included":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Customers on the roster now."}},"required":["data","nextCursor","totalCount","pageIndex","facetOptions","facetTotalCount","query","editable","editBlockedReason","audienceTypes","campaignId","included"],"additionalProperties":false},"DiscoveryRosterQuotesGetResponse":{"type":"object","properties":{"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customerCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Customers the add would put on the roster: those not on it already."},"interactionLabel":{"type":"object","properties":{"singular":{"type":"string"},"plural":{"type":"string"}},"required":["singular","plural"],"additionalProperties":false,"description":"What one unit of this work is called."},"conversations":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Conversations they bring every monthly refresh."},"estimate":{"anyOf":[{"type":"object","properties":{"count":{"type":"integer","minimum":0,"maximum":9007199254740991},"unitPriceCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"amountCents":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["count","unitPriceCents","amountCents"],"additionalProperties":false},{"type":"null"}],"description":"Those conversations at today's price; null when none can be priced now."},"billingRefusal":{"anyOf":[{"type":"object","properties":{"reason":{"type":"string","enum":["no_subscription","subscription_paused","subscription_canceled","billing_past_due","billing_suspended","billing_closed","interaction_unavailable","interaction_overage_disabled","interaction_held_by_turn","interaction_usage_pending","spend_ceiling_exceeded"]},"message":{"type":"string"},"paymentDisputeHold":{"description":"A payment dispute holds the account; its one action is support.","type":"boolean","const":true}},"required":["reason","message"],"additionalProperties":false},{"type":"null"}],"description":"Why Billing would not admit the work; null when it would."}},"required":["campaignId","customerCount","interactionLabel","conversations","estimate","billingRefusal"],"additionalProperties":false},"DiscoveryRosterMembersAddRequest":{"type":"object","properties":{"campaignId":{"type":"string","minLength":1,"maxLength":100,"description":"The Discovery campaign's id, or its campaign key."},"customerIds":{"minItems":1,"maxItems":1000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":"The customers' ids (1–1000)"}},"required":["campaignId","customerIds"],"additionalProperties":false},"DiscoveryRosterMembersAddResponse":{"type":"object","properties":{"changed":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Customers who joined."},"start":{"anyOf":[{"type":"object","properties":{"cycle":{"type":"string","description":"The UTC month (YYYY-MM) they are placed in."},"thisCycle":{"type":"boolean","description":"Whether that is the month they joined in, not the next one."},"firstConversationAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}],"description":"The earliest their first conversation can start; null while no run is coming."}},"required":["cycle","thisCycle","firstConversationAt"],"additionalProperties":false},{"type":"null"}],"description":"When they start; null when none joined."}},"required":["changed","start"],"additionalProperties":false},"DiscoveryRosterMembersRemoveRequest":{"type":"object","properties":{"campaignId":{"type":"string","minLength":1,"maxLength":100,"description":"The Discovery campaign's id, or its campaign key."},"customerIds":{"minItems":1,"maxItems":1000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":"The customers' ids (1–1000)"}},"required":["campaignId","customerIds"],"additionalProperties":false},"DiscoveryRosterMembersRemoveResponse":{"type":"object","properties":{"changed":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Customers who left."}},"required":["changed"],"additionalProperties":false},"DiscoveryRosterMembersReplaceRequest":{"type":"object","properties":{"campaignId":{"type":"string","minLength":1,"maxLength":100,"description":"The Discovery campaign's id, or its campaign key."},"fromCustomerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The customer who leaves."},"toCustomerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The customer who joins in their place."}},"required":["campaignId","fromCustomerId","toCustomerId"],"additionalProperties":false},"DiscoveryRosterMembersReplaceResponse":{"type":"object","properties":{"changed":{"type":"integer","minimum":0,"maximum":9007199254740991},"start":{"type":"object","properties":{"cycle":{"type":"string","description":"The UTC month (YYYY-MM) they are placed in."},"thisCycle":{"type":"boolean","description":"Whether that is the month they joined in, not the next one."},"firstConversationAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}],"description":"The earliest their first conversation can start; null while no run is coming."}},"required":["cycle","thisCycle","firstConversationAt"],"additionalProperties":false,"description":"When the replacement starts."}},"required":["changed","start"],"additionalProperties":false},"DiscoveryDashboardViewsListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"view":{"type":"string","enum":["discovery_brand_share_trend","discovery_brand_win_rate_trend","discovery_competitor_leaderboard","discovery_brand_map","discovery_win_rate_by_location"]},"title":{"type":"string"},"description":{"type":"string"},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"scope":{"type":"string","enum":["organization","campaign"]},"path":{"type":"string","description":"The dashboard page that shows the view."},"filters":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Pass it as this input field of discovery_dashboard_views_get."},"label":{"type":"string"},"description":{"type":"string"},"required":{"type":"boolean"},"values":{"description":"Its only accepted values: a closed list, or, read for a campaign, the brands brand_perspective can name.","type":"array","items":{"type":"string"}},"range":{"description":"Read for a campaign, date_range's: the first and last UTC days its results hold a conversation; null while it has none.","anyOf":[{"type":"object","properties":{"from":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"to":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"}},"required":["from","to"],"additionalProperties":false},{"type":"null"}]}},"required":["name","label","description","required"],"additionalProperties":false}}},"required":["view","title","description","version","scope","path","filters"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"DiscoveryDashboardViewsGetResponse":{"type":"object","properties":{"view":{"type":"string","enum":["discovery_brand_share_trend","discovery_brand_win_rate_trend","discovery_competitor_leaderboard","discovery_brand_map","discovery_win_rate_by_location"],"description":"The view's id."},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"The version of the view's snapshot; its card draws only its own."},"title":{"type":"string","description":"The view's title, as its card's host shows it."},"campaign":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false,"description":"The campaign the view reads."},"filters":{"$ref":"#/components/schemas/DiscoveryFilters"},"filterLabels":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"The filter's name, as its view declares it."},"label":{"type":"string","description":"The filter's short label, as every host shows it."},"value":{"type":"string","description":"The value it was read with, as the dashboard shows it."}},"required":["key","label","value"],"additionalProperties":false},"description":"The filters as a host labels them, in the view's declared order."},"window":{"type":"object","properties":{"from":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"The first UTC day a trend plots: the range's, never before the first interaction."},"to":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"The last UTC day a trend plots: the range's end, never past today."},"asOf":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"The UTC day every single value is as of: its value is the average over the campaign's interactions dated in the 30 days ending with it. The range's end, or, when those 30 days hold none, the last day with an interaction."},"comparedTo":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"The day a change compares with: 30 days before asOf."},"interactionCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The interactions dated in the 30 days ending asOf, under the scope."},"customerCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The distinct customers of those interactions."}},"required":["from","to","asOf","comparedTo","interactionCount","customerCount"],"additionalProperties":false,"description":"The results window the view's values read: every value is as of asOf, over the conversations dated in the 30 days ending it."},"snapshot":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/JsonValue"},"description":"The view's card's display model, which only Point11's view renders. Non-finite numbers are tagged objects; its shape is versioned by `version`."},"snapshotDigest":{"type":"string","pattern":"^[0-9a-f]{64}$","description":"SHA-256 of the view's id, version and snapshot: two answers with the same digest draw the same card."},"canonicalHref":{"type":"string","pattern":"^\\/app\\/.*","description":"The dashboard page that shows the view, under the same filters."}},"required":["view","version","title","campaign","filters","filterLabels","window","snapshot","snapshotDigest","canonicalHref"],"additionalProperties":false},"DiscoveryDashboardViewImagesCreateRequest":{"type":"object","properties":{"views":{"minItems":1,"maxItems":12,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."},"view":{"type":"string","enum":["discovery_brand_share_trend","discovery_brand_win_rate_trend","discovery_competitor_leaderboard","discovery_brand_map","discovery_win_rate_by_location"],"description":"The dashboard view, as discovery_dashboard_views_list lists it."},"date_range":{"type":"string","description":"Required. Use \"all\" or one absolute UTC-day range in yyyy-MM-dd..yyyy-MM-dd form. Preset names are not accepted because a saved answer must not move over time."},"brand_perspective":{"description":"Optional exact brand name for the dashboard's read-only perspective. Omit for the campaign's target brand.","type":"string","minLength":1,"maxLength":240},"geography":{"description":"Optional exact navigable dashboard-scope id or unambiguous visible label of a place with places under it, for example \"Texas\". Omit for World, the dashboard default scope.","type":"string","minLength":1,"maxLength":240},"geography_view":{"description":"Optional. \"list\" for the ranked table, or \"map\" for the countries filled on a world map, which is drawn only at World (no geography). Omit for the map where it can be drawn, else the list.","type":"string","enum":["map","list"]}},"required":["id","view","date_range"],"additionalProperties":false},"description":"The views to draw, in the order the images are answered; each as discovery_dashboard_views_get takes it."},"format":{"type":"string","enum":["slide","square","card"],"description":"slide: a 16:9 frame (1600×900 at scale 1); square: 1080×1080; card: the card at its reading width (1008), as tall as it draws."},"theme":{"default":"light","description":"light (the default, for slides) or dark.","type":"string","enum":["light","dark"]},"scale":{"default":2,"description":"Image pixels per frame pixel: 2 (the default; crisp on projectors) or 1.","type":"number","enum":[1,2]}},"required":["views","format"],"additionalProperties":false},"DiscoveryDashboardViewImagesCreateResponse":{"type":"object","properties":{"images":{"type":"array","items":{"type":"object","properties":{"imageId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"view":{"type":"string","description":"The view it draws."},"title":{"type":"string","description":"The view's title, as the image's footer names it."},"width":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"The PNG's width in pixels."},"height":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"The PNG's height in pixels."},"provenance":{"$ref":"#/components/schemas/DiscoveryProvenance"},"download":{"type":"object","properties":{"url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"A presigned GET of the PNG that works until expiresAt; null when this deployment cannot sign it."},"expiresAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"filename":{"type":"string","minLength":1},"contentType":{"type":"string","const":"image/png"}},"required":["url","expiresAt","filename","contentType"],"additionalProperties":false},"preview":{"anyOf":[{"type":"object","properties":{"mimeType":{"type":"string","const":"image/webp"},"data":{"type":"string","description":"The preview's bytes, base64."}},"required":["mimeType","data"],"additionalProperties":false},{"type":"null"}],"description":"A model-sized preview (long edge at most 1024 px); null when unreadable."}},"required":["imageId","view","title","width","height","provenance","download","preview"],"additionalProperties":false}}},"required":["images"],"additionalProperties":false},"DiscoveryDashboardViewImagesGetResponse":{"type":"object","properties":{"imageId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"view":{"type":"string","description":"The view it draws."},"title":{"type":"string","description":"The view's title, as the image's footer names it."},"width":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"The PNG's width in pixels."},"height":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"The PNG's height in pixels."},"provenance":{"$ref":"#/components/schemas/DiscoveryProvenance"}},"required":["imageId","view","title","width","height","provenance"],"additionalProperties":false},"DiscoveryDashboardViewImagesDownloadResponse":{"type":"object","properties":{"filename":{"type":"string","minLength":1,"description":"Suggested file name for saving the bytes"},"contentType":{"type":"string","minLength":1},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Short-lived presigned URL that GETs the bytes; null when this deployment cannot sign the object"},"expiresAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}],"description":"When url stops working (minutes after the call); null with url"},"imageId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["filename","contentType","byteLength","url","expiresAt","imageId"],"additionalProperties":false},"AlphaCreativeModelsGetResponse":{"type":"object","properties":{"controls":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","enum":["research.ask_data","research.ask_data_creation","research.alpha_create_image","research.alpha_edit_image"]},"label":{"type":"string"},"defaultModelId":{"type":"string"},"options":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"selection":{"$ref":"#/components/schemas/AlphaSelection"},"supportsReferences":{"type":"boolean"}},"required":["name","selection","supportsReferences"],"additionalProperties":false}}},"required":["key","label","defaultModelId","options"],"additionalProperties":false}},"catalogAvailable":{"type":"boolean"},"videoModelId":{"type":"string"},"speechModelId":{"type":"string"},"musicModelId":{"type":"string"},"soundModelId":{"type":"string"}},"required":["controls","catalogAvailable","videoModelId","speechModelId","musicModelId","soundModelId"],"additionalProperties":false},"AlphaCreativeCatalogGetResponse":{"type":"object","properties":{"revisions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sourceKey":{"type":"string","enum":["meta","google-search","youtube","linkedin","tiktok","google-display","microsoft","pinterest","reddit","amazon","snapchat","spotify","x"]},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"confirmedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/AlphaOutputsItem"}}},"required":["id","sourceKey","publishedAt","confirmedAt","outputs"],"additionalProperties":false}},"enabledPlatforms":{"type":"array","items":{"type":"string","enum":["Facebook","Instagram","Google Search","YouTube","LinkedIn","TikTok","Google Display","Gmail","Discover","Microsoft / Bing","Pinterest","Reddit","Amazon","Snapchat","Spotify and podcasts","X"]}}},"required":["revisions","enabledPlatforms"],"additionalProperties":false},"AlphaCreativeProjectsListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/AlphaCreativeProjectsSelectResponse"}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"AlphaCreativeProjectsGetResponse":{"type":"object","properties":{"project":{"$ref":"#/components/schemas/AlphaCreativeProjectsSelectResponse"},"rounds":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"projectId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ordinal":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"mode":{"type":"string","enum":["variants","edit","exact"]},"baseArtifactId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"instruction":{"type":"string","maxLength":4000},"target":{"$ref":"#/components/schemas/AlphaTarget"},"turnId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"pricingPolicy":{"anyOf":[{"type":"string","const":"studio-api-v1"},{"type":"null"}]},"models":{"$ref":"#/components/schemas/AlphaModels"},"refusal":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","minLength":1,"maxLength":100},"message":{"type":"string","minLength":1,"maxLength":1000}},"required":["code","message"],"additionalProperties":false},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"result":{"type":"object","properties":{"status":{"type":"string","enum":["unsubmitted","refused","reserved","running","succeeded","failed","unavailable"]},"alternatives":{"type":"array","items":{"type":"object","properties":{"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"title":{"type":"string"},"kind":{"type":"string","enum":["markdown","slides","image","audio","video","brand_kit","presentation","spreadsheet","word","pdf","csv","page"]},"mediaType":{"type":"string","enum":["text/markdown","application/vnd.point11.slides+json","image/png","image/jpeg","image/webp","audio/mpeg","audio/wav","video/mp4","video/webm","application/vnd.point11.brand-kit+json","application/vnd.openxmlformats-officedocument.presentationml.presentation","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","application/vnd.openxmlformats-officedocument.wordprocessingml.document","application/pdf","text/csv","text/html","application/vnd.point11.website+json"]},"byteLength":{"type":"number","minimum":0},"previewArtifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"isPackage":{"type":"boolean"},"deliverables":{"type":"array","items":{"$ref":"#/components/schemas/AlphaDeliverablesItem"}},"deliverableFiles":{"type":"array","items":{"type":"object","properties":{"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"title":{"type":"string"},"kind":{"type":"string","enum":["markdown","slides","image","audio","video","brand_kit","presentation","spreadsheet","word","pdf","csv","page"]},"mediaType":{"type":"string","enum":["text/markdown","application/vnd.point11.slides+json","image/png","image/jpeg","image/webp","audio/mpeg","audio/wav","video/mp4","video/webm","application/vnd.point11.brand-kit+json","application/vnd.openxmlformats-officedocument.presentationml.presentation","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","application/vnd.openxmlformats-officedocument.wordprocessingml.document","application/pdf","text/csv","text/html","application/vnd.point11.website+json"]},"byteLength":{"type":"number","minimum":0}},"required":["artifactId","title","kind","mediaType"],"additionalProperties":false}}},"required":["artifactId","title","kind","mediaType","byteLength"],"additionalProperties":false}},"billing":{"anyOf":[{"type":"object","properties":{"runId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"pricingPolicy":{"type":"string","const":"studio-api-v1"},"state":{"type":"string","enum":["pending","settled","absorbed"]},"amountUsd":{"anyOf":[{"type":"string"},{"type":"null"}]},"knownSubtotalUsd":{"type":"string"},"unresolvedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"settledAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"delivery":{"anyOf":[{"type":"object","properties":{"hourStart":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"state":{"type":"string","enum":["unreported","accepted","verified","expired"]}},"required":["hourStart","state"],"additionalProperties":false},{"type":"null"}]}},"required":["runId","pricingPolicy","state","amountUsd","knownSubtotalUsd","unresolvedCount","settledAt","delivery"],"additionalProperties":false},{"type":"null"}]}},"required":["status","alternatives","billing"],"additionalProperties":false}},"required":["id","projectId","ordinal","mode","baseArtifactId","instruction","target","turnId","pricingPolicy","refusal","createdAt","result"],"additionalProperties":false}},"nextRoundsCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"deliveredFileCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["project","rounds","nextRoundsCursor","deliveredFileCount"],"additionalProperties":false},"AlphaCreativeProjectsCreateRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":160},"brief":{"$ref":"#/components/schemas/AlphaBrief"},"brand":{"anyOf":[{"type":"object","properties":{"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["artifactId"],"additionalProperties":false},{"type":"object","properties":{"unbranded":{"type":"boolean","const":true}},"required":["unbranded"],"additionalProperties":false}]}},"required":["id","name","brief"],"additionalProperties":false},"AlphaCreativeProjectsCreateResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"conversationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":160},"brief":{"$ref":"#/components/schemas/AlphaBrief"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"brandKitArtifactId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"selectedArtifactId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["id","conversationId","name","brief","revision","brandKitArtifactId","selectedArtifactId","createdAt","updatedAt"],"additionalProperties":false},"AlphaCreativeProjectsUpdateRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"name":{"type":"string","minLength":1,"maxLength":160},"brief":{"$ref":"#/components/schemas/AlphaBrief"},"brand":{"anyOf":[{"type":"object","properties":{"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["artifactId"],"additionalProperties":false},{"type":"object","properties":{"unbranded":{"type":"boolean","const":true}},"required":["unbranded"],"additionalProperties":false}]}},"required":["id","revision","name","brief"],"additionalProperties":false},"AlphaCreativeProjectsUpdateResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"conversationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":160},"brief":{"$ref":"#/components/schemas/AlphaBrief"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"brandKitArtifactId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"selectedArtifactId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["id","conversationId","name","brief","revision","brandKitArtifactId","selectedArtifactId","createdAt","updatedAt"],"additionalProperties":false},"AlphaCreativeProjectsSelectRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["id","revision","artifactId"],"additionalProperties":false},"AlphaCreativeProjectsSelectResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"conversationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":160},"brief":{"$ref":"#/components/schemas/AlphaBrief"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"brandKitArtifactId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"selectedArtifactId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["id","conversationId","name","brief","revision","brandKitArtifactId","selectedArtifactId","createdAt","updatedAt"],"additionalProperties":false},"AlphaCreativeRoundsGetResponse":{"type":"object","properties":{"project":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":160},"conversationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["id","name","conversationId"],"additionalProperties":false},"round":{"$ref":"#/components/schemas/AlphaRound"},"brief":{"$ref":"#/components/schemas/AlphaBrief"},"brandKitArtifactId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["project","round","brief","brandKitArtifactId"],"additionalProperties":false},"AlphaCreativeRoundsCreateRequest":{"type":"object","properties":{"roundId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"projectId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"mode":{"type":"string","enum":["variants","edit","exact"]},"pricingPolicy":{"type":"string","const":"studio-api-v1"},"instruction":{"type":"string","maxLength":4000},"baseArtifactId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"target":{"$ref":"#/components/schemas/AlphaTargetVariant"},"models":{"$ref":"#/components/schemas/AlphaModels"}},"additionalProperties":false},"AlphaCreativeRoundsCreateResponse":{"type":"object","properties":{"project":{"$ref":"#/components/schemas/AlphaCreativeProjectsSelectResponse"},"round":{"$ref":"#/components/schemas/AlphaRound"}},"required":["project","round"],"additionalProperties":false},"AlphaAvailabilityGetResponse":{"type":"object","properties":{"visible":{"type":"boolean"},"reason":{"anyOf":[{"type":"string","enum":["no_subscription","subscription_paused","subscription_canceled","billing_past_due","billing_suspended","billing_closed","paused_organization","paused_global"]},{"type":"null"}]},"action":{"anyOf":[{"type":"string","enum":["subscribe","undo_cancel","continue_payment","update_card","contact_support"]},{"type":"null"}],"description":"While closed, the one Billing action in Settings that opens Alpha again; null while open, for an operator's pause, or with no billing relationship"}},"required":["visible","reason","action"],"additionalProperties":false},"AlphaWorkflowsListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"workflowKey":{"type":"string","pattern":"^wf_[a-f0-9]{32}$"},"name":{"type":"string"},"description":{"type":"string"},"origin":{"type":"string","enum":["system_template","advisor_generated","customer_authored"]},"draftRevision":{"type":"integer","minimum":1,"maximum":9007199254740991},"latestVersion":{"anyOf":[{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},{"type":"null"}]},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"lastRun":{"anyOf":[{"type":"object","properties":{"status":{"type":"string","enum":["pending","running","succeeded","failed","cancelled"]},"executionStatus":{"type":"string","enum":["scheduled","waiting","running","completed","failed","cancelled"]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["status","executionStatus","createdAt"],"additionalProperties":false},{"type":"null"}]},"schedule":{"anyOf":[{"type":"object","properties":{"frequency":{"type":"string","enum":["daily","weekly","monthly"]},"delivery":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"none"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"slack"},"channel":{"type":"string"}},"required":["kind","channel"],"additionalProperties":false}]},"nextAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]}},"required":["frequency","delivery","nextAt"],"additionalProperties":false},{"type":"null"}]}},"required":["workflowKey","name","description","origin","draftRevision","latestVersion","updatedAt","lastRun","schedule"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"totalCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Workflows matching the query across every page"}},"required":["data","nextCursor","totalCount"],"additionalProperties":false},"AlphaWorkflowsGetResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"workflowKey":{"type":"string","pattern":"^wf_[a-f0-9]{32}$"},"name":{"type":"string"},"description":{"type":"string"},"origin":{"type":"string","enum":["system_template","advisor_generated","customer_authored"]},"status":{"type":"string","enum":["active","archived","deleted"]},"graph":{"oneOf":[{"$ref":"#/components/schemas/AlphaGraph"},{"$ref":"#/components/schemas/AlphaGraph2"},{"$ref":"#/components/schemas/AlphaGraph3"},{"$ref":"#/components/schemas/AlphaGraph4"}]},"draftRevision":{"type":"integer","minimum":1,"maximum":9007199254740991},"latestVersion":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"draftRevision":{"type":"integer","minimum":1,"maximum":9007199254740991},"graphFingerprint":{"type":"string"},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["id","version","draftRevision","graphFingerprint","publishedAt"],"additionalProperties":false},{"type":"null"}]},"recentRuns":{"$ref":"#/components/schemas/AlphaRecentRuns"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["id","workflowKey","name","description","origin","status","graph","draftRevision","latestVersion","recentRuns","updatedAt"],"additionalProperties":false},"AlphaWorkflowsGetV2Response":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"workflowKey":{"type":"string","pattern":"^wf_[a-f0-9]{32}$"},"name":{"type":"string"},"description":{"type":"string"},"origin":{"type":"string","enum":["system_template","advisor_generated","customer_authored"]},"status":{"type":"string","enum":["active","archived","deleted"]},"graph":{"$ref":"#/components/schemas/AlphaGraph5"},"draftRevision":{"type":"integer","minimum":1,"maximum":9007199254740991},"latestVersion":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"draftRevision":{"type":"integer","minimum":1,"maximum":9007199254740991},"graphFingerprint":{"type":"string"},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["id","version","draftRevision","graphFingerprint","publishedAt"],"additionalProperties":false},{"type":"null"}]},"recentRuns":{"$ref":"#/components/schemas/AlphaRecentRuns"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["id","workflowKey","name","description","origin","status","graph","draftRevision","latestVersion","recentRuns","updatedAt"],"additionalProperties":false},"AlphaWorkflowsCreateRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120,"description":"The report's name, as Scheduled lists it"},"instructions":{"type":"string","minLength":8,"maxLength":3000,"description":"What each run reads from the organization's Point11 data and reports"}},"required":["name","instructions"],"additionalProperties":false},"AlphaWorkflowsCreateResponse":{"type":"object","properties":{"workflowKey":{"type":"string","pattern":"^wf_[a-f0-9]{32}$"},"draftRevision":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["workflowKey","draftRevision"],"additionalProperties":false},"AlphaSolutionDesignWorkflowsCreateRequest":{"type":"object","properties":{"sourceReportRunId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"audience":{"type":"string","minLength":8,"maxLength":1000},"goal":{"type":"string","minLength":8,"maxLength":1000}},"required":["sourceReportRunId","audience","goal"],"additionalProperties":false},"AlphaSolutionDesignWorkflowsCreateResponse":{"type":"object","properties":{"workflowKey":{"type":"string","pattern":"^wf_[a-f0-9]{32}$"},"draftRevision":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["workflowKey","draftRevision"],"additionalProperties":false},"AlphaWorkflowsUpdateRequest":{"type":"object","properties":{"workflowKey":{"type":"string","pattern":"^wf_[a-f0-9]{32}$"},"expectedRevision":{"type":"integer","minimum":1,"maximum":9007199254740991},"graph":{"$ref":"#/components/schemas/AlphaGraph5"}},"required":["workflowKey","expectedRevision","graph"],"additionalProperties":false},"AlphaWorkflowsUpdateResponse":{"type":"object","properties":{"workflowKey":{"type":"string","pattern":"^wf_[a-f0-9]{32}$"},"revision":{"type":"integer","minimum":1,"maximum":9007199254740991},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["workflowKey","revision","updatedAt"],"additionalProperties":false},"AlphaWorkflowsPublishRequest":{"type":"object","properties":{"workflowKey":{"type":"string","pattern":"^wf_[a-f0-9]{32}$"},"expectedRevision":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["workflowKey","expectedRevision"],"additionalProperties":false},"AlphaWorkflowsPublishResponse":{"type":"object","properties":{"workflowKey":{"type":"string","pattern":"^wf_[a-f0-9]{32}$"},"versionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"draftRevision":{"type":"integer","minimum":1,"maximum":9007199254740991},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"replayed":{"type":"boolean"}},"required":["workflowKey","versionId","version","draftRevision","publishedAt","replayed"],"additionalProperties":false},"AlphaWorkflowsStartRequest":{"type":"object","properties":{"workflowKey":{"type":"string","pattern":"^wf_[a-f0-9]{32}$","description":"Published Alpha workflow key"},"expectedWorkflowVersionId":{"description":"Optional immutable workflow version the caller confirmed","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["workflowKey"],"additionalProperties":false},"AlphaWorkflowsStartResponse":{"type":"object","properties":{"runId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The billing.runs ID of the workflow run"},"status":{"type":"string","enum":["started","pending_redelivery"],"description":"started: Workflow accepted the run. pending_redelivery: the run is reserved and its Workflow start is redelivered."},"workflowKey":{"type":"string","pattern":"^wf_[a-f0-9]{32}$"}},"required":["runId","status","workflowKey"],"additionalProperties":false},"AlphaWorkflowArtifactsDownloadResponse":{"type":"object","properties":{"filename":{"type":"string","minLength":1,"description":"Suggested file name for saving the bytes"},"contentType":{"type":"string","minLength":1},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Short-lived presigned URL that GETs the bytes; null when this deployment cannot sign the object"},"expiresAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}],"description":"When url stops working (minutes after the call); null with url"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["filename","contentType","byteLength","url","expiresAt","id"],"additionalProperties":false},"AlphaReportsGetResponse":{"type":"object","properties":{"runId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Alpha report ID (the report's run ID)"},"status":{"type":"string","enum":["pending","running","succeeded","failed","cancelled"]},"executionStatus":{"type":"string","enum":["scheduled","waiting","running","completed","failed","cancelled"],"description":"The status in Point11's shared execution vocabulary, as every run badge shows it"},"workflowKey":{"type":"string","pattern":"^wf_[a-f0-9]{32}$","description":"Published Alpha internal-report workflow key"},"workflowName":{"type":"string","minLength":1,"maxLength":120},"workflowVersionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"workflowVersion":{"type":"integer","minimum":1,"maximum":9007199254740991},"workflowPublishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"startedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"source":{"type":"object","properties":{"kind":{"type":"string","const":"internal_report"},"campaign":{"type":"object","properties":{"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":120}},"required":["campaignId","name"],"additionalProperties":false},"actions":{"minItems":1,"maxItems":5,"type":"array","items":{"type":"object","properties":{"actionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"title":{"type":"string","minLength":1,"maxLength":120}},"required":["actionId","title"],"additionalProperties":false}}},"required":["kind","campaign","actions"],"additionalProperties":false}},"required":["runId","status","executionStatus","workflowKey","workflowName","workflowVersionId","workflowVersion","workflowPublishedAt","createdAt","startedAt","completedAt","source"],"additionalProperties":false},"AlphaReportResultsGetResponse":{"type":"object","properties":{"runId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Alpha report ID (the report's run ID)"},"status":{"type":"string","const":"succeeded"},"executionStatus":{"type":"string","enum":["scheduled","waiting","running","completed","failed","cancelled"],"description":"The status in Point11's shared execution vocabulary, as every run badge shows it"},"workflowKey":{"type":"string","pattern":"^wf_[a-f0-9]{32}$","description":"Published Alpha internal-report workflow key"},"workflowName":{"type":"string","minLength":1,"maxLength":120},"workflowVersionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"workflowVersion":{"type":"integer","minimum":1,"maximum":9007199254740991},"workflowPublishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"startedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"source":{"type":"object","properties":{"kind":{"type":"string","const":"internal_report"},"campaign":{"type":"object","properties":{"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":120}},"required":["campaignId","name"],"additionalProperties":false},"actions":{"minItems":1,"maxItems":5,"type":"array","items":{"type":"object","properties":{"actionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"title":{"type":"string","minLength":1,"maxLength":120}},"required":["actionId","title"],"additionalProperties":false}}},"required":["kind","campaign","actions"],"additionalProperties":false},"result":{"type":"object","properties":{"deliverables":{"minItems":1,"maxItems":30,"type":"array","items":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":120},"content":{"type":"string","minLength":1,"maxLength":20000}},"required":["label","content"],"additionalProperties":false}}},"required":["deliverables"],"additionalProperties":false}},"required":["runId","status","executionStatus","workflowKey","workflowName","workflowVersionId","workflowVersion","workflowPublishedAt","createdAt","startedAt","completedAt","source","result"],"additionalProperties":false},"AlphaReportResultsGetV2Response":{"type":"object","properties":{"runId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Alpha report ID (the report's run ID)"},"status":{"type":"string","enum":["pending","running","succeeded","failed","cancelled"]},"executionStatus":{"type":"string","enum":["scheduled","waiting","running","completed","failed","cancelled"],"description":"The status in Point11's shared execution vocabulary, as every run badge shows it"},"workflowKey":{"type":"string","pattern":"^wf_[a-f0-9]{32}$","description":"Published Alpha internal-report workflow key"},"workflowName":{"type":"string","minLength":1,"maxLength":120},"workflowVersionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"workflowVersion":{"type":"integer","minimum":1,"maximum":9007199254740991},"workflowPublishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"startedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"source":{"type":"object","properties":{"kind":{"type":"string","const":"internal_report"},"campaign":{"type":"object","properties":{"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":120}},"required":["campaignId","name"],"additionalProperties":false},"actions":{"minItems":1,"maxItems":5,"type":"array","items":{"type":"object","properties":{"actionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"title":{"type":"string","minLength":1,"maxLength":120}},"required":["actionId","title"],"additionalProperties":false}}},"required":["kind","campaign","actions"],"additionalProperties":false},"result":{"anyOf":[{"type":"object","properties":{"deliverables":{"minItems":1,"maxItems":30,"type":"array","items":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":120},"content":{"type":"string","minLength":1,"maxLength":20000}},"required":["label","content"],"additionalProperties":false}}},"required":["deliverables"],"additionalProperties":false},{"type":"null"}],"description":"The accepted report text once the run has succeeded; null until then"}},"required":["runId","status","executionStatus","workflowKey","workflowName","workflowVersionId","workflowVersion","workflowPublishedAt","createdAt","startedAt","completedAt","source","result"],"additionalProperties":false},"AlphaBrandKitsListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"kitKey":{"type":"string"},"name":{"type":"string"},"version":{"type":"integer","minimum":0,"maximum":9007199254740991},"currentRevisionArtifactId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["kitKey","name","version","currentRevisionArtifactId","updatedAt"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"AlphaBrandKitsGetResponse":{"type":"object","properties":{"kit":{"$ref":"#/components/schemas/AlphaKit"},"revision":{"$ref":"#/components/schemas/AlphaRevision"}},"required":["kit","revision"],"additionalProperties":false},"AlphaBrandKitsGetV2Response":{"type":"object","properties":{"kit":{"$ref":"#/components/schemas/AlphaKit"},"revision":{"$ref":"#/components/schemas/AlphaRevision2"}},"required":["kit","revision"],"additionalProperties":false},"AlphaBrandKitWorkspacesGetResponse":{"type":"object","properties":{"kits":{"$ref":"#/components/schemas/AlphaKits"},"kitPage":{"type":"integer","minimum":0,"maximum":9007199254740991},"hasMoreKits":{"type":"boolean"},"totalCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"defaultKitId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"defaults":{"type":"object","properties":{"kitId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"version":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["kitId","version"],"additionalProperties":false},"profileBinding":{"anyOf":[{"type":"object","properties":{"profileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"kitId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"version":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["profileId","kitId","version"],"additionalProperties":false},{"type":"null"}]},"selected":{"anyOf":[{"type":"object","properties":{"kit":{"$ref":"#/components/schemas/AlphaKit"},"revision":{"$ref":"#/components/schemas/AlphaRevision"},"runs":{"$ref":"#/components/schemas/AlphaBrandKitRunsListResponse"}},"required":["kit","revision","runs"],"additionalProperties":false},{"type":"null"}]}},"required":["kits","kitPage","hasMoreKits","totalCount","defaultKitId","defaults","profileBinding","selected"],"additionalProperties":false},"AlphaBrandKitWorkspacesGetV2Response":{"type":"object","properties":{"kits":{"$ref":"#/components/schemas/AlphaKits"},"kitPage":{"type":"integer","minimum":0,"maximum":9007199254740991},"hasMoreKits":{"type":"boolean"},"totalCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"defaultKitId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"defaults":{"type":"object","properties":{"kitId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"version":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["kitId","version"],"additionalProperties":false},"profileBinding":{"anyOf":[{"type":"object","properties":{"profileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"kitId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"version":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["profileId","kitId","version"],"additionalProperties":false},{"type":"null"}]},"selected":{"anyOf":[{"type":"object","properties":{"kit":{"$ref":"#/components/schemas/AlphaKit"},"revision":{"$ref":"#/components/schemas/AlphaRevision2"},"runs":{"$ref":"#/components/schemas/AlphaBrandKitRunsListResponse"}},"required":["kit","revision","runs"],"additionalProperties":false},{"type":"null"}]}},"required":["kits","kitPage","hasMoreKits","totalCount","defaultKitId","defaults","profileBinding","selected"],"additionalProperties":false},"AlphaBrandKitRunsListResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AlphaData"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"AlphaBrandKitsCreateRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"sourceUrl":{"type":"string","maxLength":2048,"format":"uri"},"profileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["name","sourceUrl"],"additionalProperties":false},"AlphaBrandKitsCreateResponse":{"type":"object","properties":{"kitKey":{"type":"string"},"runId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"status":{"type":"string","enum":["started","refused"]},"refusal":{"anyOf":[{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"paymentDisputeHold":{"description":"A payment dispute holds the account; its one action is support.","type":"boolean","const":true}},"required":["code","message"],"additionalProperties":false},{"type":"null"}]}},"required":["kitKey","runId","status","refusal"],"additionalProperties":false},"AlphaBrandKitsRefreshRequest":{"type":"object","properties":{"kitKey":{"type":"string","minLength":1,"maxLength":160},"expectedVersion":{"type":"integer","minimum":0,"maximum":9007199254740991},"profileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kitKey","expectedVersion"],"additionalProperties":false},"AlphaBrandKitsRefreshResponse":{"type":"object","properties":{"kitKey":{"type":"string"},"runId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"status":{"type":"string","enum":["started","refused"]},"refusal":{"anyOf":[{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"paymentDisputeHold":{"description":"A payment dispute holds the account; its one action is support.","type":"boolean","const":true}},"required":["code","message"],"additionalProperties":false},{"type":"null"}]}},"required":["kitKey","runId","status","refusal"],"additionalProperties":false},"AlphaBrandKitsUpdateRequest":{"type":"object","properties":{"kitKey":{"type":"string","minLength":1,"maxLength":160},"expectedVersion":{"type":"integer","minimum":0,"maximum":9007199254740991},"document":{"anyOf":[{"type":"object","properties":{"version":{"type":"string","const":"2"},"name":{"type":"string","minLength":1,"maxLength":120},"colors":{"type":"object","properties":{"primary":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"secondary":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"accent":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"background":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"text":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"palette":{"maxItems":8,"type":"array","items":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"}}},"required":["primary"],"additionalProperties":false},"typography":{"type":"object","properties":{"heading":{"type":"string","minLength":1,"maxLength":80},"body":{"type":"string","minLength":1,"maxLength":80}},"required":["heading","body"],"additionalProperties":false},"logoArtifactIds":{"default":[],"maxItems":4,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"voiceId":{"type":"string","minLength":1,"maxLength":100},"doNotRules":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":200}},"writing":{"default":{"tone":[],"terminology":[],"examples":[]},"type":"object","properties":{"tone":{"default":[],"maxItems":12,"type":"array","items":{"type":"string","minLength":1,"maxLength":120}},"audience":{"type":"string","minLength":1,"maxLength":1000},"terminology":{"default":[],"maxItems":30,"type":"array","items":{"type":"string","minLength":1,"maxLength":200}},"examples":{"default":[],"maxItems":8,"type":"array","items":{"type":"string","minLength":1,"maxLength":1000}}},"additionalProperties":false},"layout":{"default":{"spacing":[]},"type":"object","properties":{"description":{"type":"string","minLength":1,"maxLength":4000},"spacing":{"default":[],"maxItems":16,"type":"array","items":{"type":"string","minLength":1,"maxLength":120}},"corners":{"type":"string","minLength":1,"maxLength":120},"buttons":{"type":"string","minLength":1,"maxLength":1000},"imagery":{"type":"string","minLength":1,"maxLength":1000},"responsive":{"type":"string","minLength":1,"maxLength":1000},"documentTemplate":{"type":"string","minLength":1,"maxLength":4000},"presentationTemplate":{"type":"string","minLength":1,"maxLength":4000},"spreadsheetTemplate":{"type":"string","minLength":1,"maxLength":4000},"adTemplate":{"type":"string","minLength":1,"maxLength":4000},"websiteTemplate":{"type":"string","minLength":1,"maxLength":4000}},"additionalProperties":false},"evidence":{"default":{"sources":[],"gaps":[]},"type":"object","properties":{"sourceUrl":{"type":"string","maxLength":2048,"format":"uri"},"finalUrl":{"type":"string","maxLength":2048,"format":"uri"},"observedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"sources":{"default":[],"maxItems":30,"type":"array","items":{"type":"object","properties":{"url":{"type":"string","maxLength":2048,"format":"uri"},"observation":{"type":"string","minLength":1,"maxLength":2000}},"required":["url","observation"],"additionalProperties":false}},"gaps":{"default":[],"maxItems":30,"type":"array","items":{"type":"string","minLength":1,"maxLength":500}}},"additionalProperties":false},"assetUsage":{"$ref":"#/components/schemas/AlphaAssetUsage"},"overrides":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["name","colors","typography","logoArtifactIds","voiceId","doNotRules","writing","layout","assetUsage"]},"action":{"type":"string","enum":["set","remove"]},"source":{"type":"string","enum":["customer","import"]}},"required":["field","action","source"],"additionalProperties":false}}},"required":["version","name","colors","typography"],"additionalProperties":false},{"type":"object","properties":{"version":{"type":"string","const":"3"},"name":{"type":"string","minLength":1,"maxLength":120},"colors":{"type":"object","properties":{"primary":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"secondary":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"accent":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"background":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"surface":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"text":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"mutedText":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"border":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"success":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"warning":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"error":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"palette":{"maxItems":8,"type":"array","items":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"}}},"required":["primary"],"additionalProperties":false},"typography":{"type":"object","properties":{"heading":{"type":"string","minLength":1,"maxLength":80},"body":{"type":"string","minLength":1,"maxLength":80},"mono":{"type":"string","minLength":1,"maxLength":80},"scale":{"default":[],"maxItems":16,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,31}$"},"family":{"type":"string","enum":["heading","body","mono"]},"weight":{"type":"integer","minimum":100,"maximum":900},"sizePx":{"type":"number","exclusiveMinimum":0,"maximum":400},"lineHeight":{"type":"number","minimum":0.5,"maximum":4},"letterSpacingEm":{"type":"number","minimum":-0.5,"maximum":1}},"required":["name","family","weight","sizePx","lineHeight"],"additionalProperties":false}}},"required":["heading","body"],"additionalProperties":false},"logoArtifactIds":{"default":[],"maxItems":4,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"voiceId":{"type":"string","minLength":1,"maxLength":100},"doNotRules":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":200}},"writing":{"$ref":"#/components/schemas/AlphaWriting"},"layout":{"default":{"spacing":[]},"type":"object","properties":{"description":{"type":"string","minLength":1,"maxLength":4000},"spacing":{"default":[],"maxItems":16,"type":"array","items":{"type":"string","minLength":1,"maxLength":120}},"corners":{"type":"string","minLength":1,"maxLength":120},"buttons":{"type":"string","minLength":1,"maxLength":1000},"imagery":{"type":"string","minLength":1,"maxLength":1000},"responsive":{"type":"string","minLength":1,"maxLength":1000}},"additionalProperties":false},"guidance":{"default":{},"type":"object","properties":{"document":{"type":"string","minLength":1,"maxLength":4000},"presentation":{"type":"string","minLength":1,"maxLength":4000},"spreadsheet":{"type":"string","minLength":1,"maxLength":4000},"ad":{"type":"string","minLength":1,"maxLength":4000},"website":{"type":"string","minLength":1,"maxLength":4000}},"additionalProperties":false},"tokens":{"$ref":"#/components/schemas/AlphaTokens"},"claims":{"default":[],"maxItems":50,"type":"array","items":{"type":"object","properties":{"claim":{"type":"string","minLength":1,"maxLength":500},"proof":{"type":"string","minLength":1,"maxLength":1000},"proofUrl":{"type":"string","maxLength":2048,"format":"uri"},"expiresOn":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"}},"required":["claim","proof"],"additionalProperties":false}},"evidence":{"default":{"sources":[],"gaps":[]},"type":"object","properties":{"sourceUrl":{"type":"string","maxLength":2048,"format":"uri"},"finalUrl":{"type":"string","maxLength":2048,"format":"uri"},"observedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"sources":{"default":[],"maxItems":30,"type":"array","items":{"type":"object","properties":{"url":{"type":"string","maxLength":2048,"format":"uri"},"observation":{"type":"string","minLength":1,"maxLength":2000}},"required":["url","observation"],"additionalProperties":false}},"gaps":{"default":[],"maxItems":30,"type":"array","items":{"type":"string","minLength":1,"maxLength":500}}},"additionalProperties":false},"assetUsage":{"$ref":"#/components/schemas/AlphaAssetUsage"},"overrides":{"default":[],"maxItems":12,"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["name","colors","typography","logoArtifactIds","voiceId","doNotRules","writing","layout","assetUsage","guidance","tokens","claims"]},"action":{"type":"string","enum":["set","remove"]},"source":{"type":"string","enum":["customer","import"]}},"required":["field","action","source"],"additionalProperties":false}}},"required":["version","name","colors","typography"],"additionalProperties":false}]}},"required":["kitKey","expectedVersion","document"],"additionalProperties":false,"deprecated":true},"AlphaBrandKitsUpdateResponse":{"type":"object","properties":{"kitKey":{"type":"string"},"revisionArtifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"status":{"type":"string","enum":["published","candidate"]}},"required":["kitKey","revisionArtifactId","status"],"additionalProperties":false},"AlphaBrandKitsUpdateV2Request":{"type":"object","properties":{"kitKey":{"type":"string","minLength":1,"maxLength":160},"expectedVersion":{"type":"integer","minimum":0,"maximum":9007199254740991},"document":{"anyOf":[{"type":"object","properties":{"version":{"type":"string","const":"2"},"name":{"type":"string","minLength":1,"maxLength":120},"colors":{"type":"object","properties":{"primary":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"secondary":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"accent":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"background":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"text":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"palette":{"maxItems":8,"type":"array","items":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"}}},"required":["primary"],"additionalProperties":false},"typography":{"type":"object","properties":{"heading":{"type":"string","minLength":1,"maxLength":80},"body":{"type":"string","minLength":1,"maxLength":80}},"required":["heading","body"],"additionalProperties":false},"logoArtifactIds":{"default":[],"maxItems":4,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"voiceId":{"type":"string","minLength":1,"maxLength":100},"doNotRules":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":200}},"writing":{"default":{"tone":[],"terminology":[],"examples":[]},"type":"object","properties":{"tone":{"default":[],"maxItems":12,"type":"array","items":{"type":"string","minLength":1,"maxLength":120}},"audience":{"type":"string","minLength":1,"maxLength":1000},"terminology":{"default":[],"maxItems":30,"type":"array","items":{"type":"string","minLength":1,"maxLength":200}},"examples":{"default":[],"maxItems":8,"type":"array","items":{"type":"string","minLength":1,"maxLength":1000}}},"additionalProperties":false},"layout":{"default":{"spacing":[]},"type":"object","properties":{"description":{"type":"string","minLength":1,"maxLength":4000},"spacing":{"default":[],"maxItems":16,"type":"array","items":{"type":"string","minLength":1,"maxLength":120}},"corners":{"type":"string","minLength":1,"maxLength":120},"buttons":{"type":"string","minLength":1,"maxLength":1000},"imagery":{"type":"string","minLength":1,"maxLength":1000},"responsive":{"type":"string","minLength":1,"maxLength":1000},"documentTemplate":{"type":"string","minLength":1,"maxLength":4000},"presentationTemplate":{"type":"string","minLength":1,"maxLength":4000},"spreadsheetTemplate":{"type":"string","minLength":1,"maxLength":4000},"adTemplate":{"type":"string","minLength":1,"maxLength":4000},"websiteTemplate":{"type":"string","minLength":1,"maxLength":4000}},"additionalProperties":false},"evidence":{"default":{"sources":[],"gaps":[]},"type":"object","properties":{"sourceUrl":{"type":"string","maxLength":2048,"format":"uri"},"finalUrl":{"type":"string","maxLength":2048,"format":"uri"},"observedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"sources":{"default":[],"maxItems":30,"type":"array","items":{"type":"object","properties":{"url":{"type":"string","maxLength":2048,"format":"uri"},"observation":{"type":"string","minLength":1,"maxLength":2000}},"required":["url","observation"],"additionalProperties":false}},"gaps":{"default":[],"maxItems":30,"type":"array","items":{"type":"string","minLength":1,"maxLength":500}}},"additionalProperties":false},"assetUsage":{"$ref":"#/components/schemas/AlphaDocumentAssetUsage"},"overrides":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["name","colors","typography","logoArtifactIds","voiceId","doNotRules","writing","layout","assetUsage"]},"action":{"type":"string","enum":["set","remove"]},"source":{"type":"string","enum":["customer","import"]}},"required":["field","action","source"],"additionalProperties":false}}},"required":["version","name","colors","typography"],"additionalProperties":false},{"type":"object","properties":{"version":{"type":"string","const":"3"},"name":{"type":"string","minLength":1,"maxLength":120},"colors":{"type":"object","properties":{"primary":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"secondary":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"accent":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"background":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"surface":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"text":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"mutedText":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"border":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"success":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"warning":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"error":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"palette":{"maxItems":8,"type":"array","items":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"}}},"required":["primary"],"additionalProperties":false},"typography":{"type":"object","properties":{"heading":{"type":"string","minLength":1,"maxLength":80},"body":{"type":"string","minLength":1,"maxLength":80},"mono":{"type":"string","minLength":1,"maxLength":80},"scale":{"default":[],"maxItems":16,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,31}$"},"family":{"type":"string","enum":["heading","body","mono"]},"weight":{"type":"integer","minimum":100,"maximum":900},"sizePx":{"type":"number","exclusiveMinimum":0,"maximum":400},"lineHeight":{"type":"number","minimum":0.5,"maximum":4},"letterSpacingEm":{"type":"number","minimum":-0.5,"maximum":1}},"required":["name","family","weight","sizePx","lineHeight"],"additionalProperties":false}}},"required":["heading","body"],"additionalProperties":false},"logoArtifactIds":{"default":[],"maxItems":4,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"voiceId":{"type":"string","minLength":1,"maxLength":100},"doNotRules":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":200}},"writing":{"$ref":"#/components/schemas/AlphaWriting"},"layout":{"default":{"spacing":[]},"type":"object","properties":{"description":{"type":"string","minLength":1,"maxLength":4000},"spacing":{"default":[],"maxItems":16,"type":"array","items":{"type":"string","minLength":1,"maxLength":120}},"corners":{"type":"string","minLength":1,"maxLength":120},"buttons":{"type":"string","minLength":1,"maxLength":1000},"imagery":{"type":"string","minLength":1,"maxLength":1000},"responsive":{"type":"string","minLength":1,"maxLength":1000}},"additionalProperties":false},"guidance":{"default":{},"type":"object","properties":{"document":{"type":"string","minLength":1,"maxLength":4000},"presentation":{"type":"string","minLength":1,"maxLength":4000},"spreadsheet":{"type":"string","minLength":1,"maxLength":4000},"ad":{"type":"string","minLength":1,"maxLength":4000},"website":{"type":"string","minLength":1,"maxLength":4000}},"additionalProperties":false},"tokens":{"$ref":"#/components/schemas/AlphaTokens"},"claims":{"default":[],"maxItems":50,"type":"array","items":{"type":"object","properties":{"claim":{"type":"string","minLength":1,"maxLength":500},"proof":{"type":"string","minLength":1,"maxLength":1000},"proofUrl":{"type":"string","maxLength":2048,"format":"uri"},"expiresOn":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"}},"required":["claim","proof"],"additionalProperties":false}},"evidence":{"default":{"sources":[],"gaps":[]},"type":"object","properties":{"sourceUrl":{"type":"string","maxLength":2048,"format":"uri"},"finalUrl":{"type":"string","maxLength":2048,"format":"uri"},"observedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"sources":{"default":[],"maxItems":30,"type":"array","items":{"type":"object","properties":{"url":{"type":"string","maxLength":2048,"format":"uri"},"observation":{"type":"string","minLength":1,"maxLength":2000}},"required":["url","observation"],"additionalProperties":false}},"gaps":{"default":[],"maxItems":30,"type":"array","items":{"type":"string","minLength":1,"maxLength":500}}},"additionalProperties":false},"assetUsage":{"$ref":"#/components/schemas/AlphaDocumentAssetUsage"},"overrides":{"default":[],"maxItems":12,"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["name","colors","typography","logoArtifactIds","voiceId","doNotRules","writing","layout","assetUsage","guidance","tokens","claims"]},"action":{"type":"string","enum":["set","remove"]},"source":{"type":"string","enum":["customer","import"]}},"required":["field","action","source"],"additionalProperties":false}}},"required":["version","name","colors","typography"],"additionalProperties":false}]}},"required":["kitKey","expectedVersion","document"],"additionalProperties":false},"AlphaBrandKitsUpdateV2Response":{"type":"object","properties":{"kitKey":{"type":"string"},"revisionArtifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"status":{"type":"string","enum":["published","candidate"]}},"required":["kitKey","revisionArtifactId","status"],"additionalProperties":false},"AlphaBrandKitsRestoreRequest":{"type":"object","properties":{"kitKey":{"type":"string","minLength":1,"maxLength":160},"expectedVersion":{"type":"integer","minimum":0,"maximum":9007199254740991},"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kitKey","expectedVersion","artifactId"],"additionalProperties":false},"AlphaBrandKitsRestoreResponse":{"type":"object","properties":{"kitKey":{"type":"string"},"revisionArtifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"status":{"type":"string","enum":["published","candidate"]}},"required":["kitKey","revisionArtifactId","status"],"additionalProperties":false},"AlphaBrandKitsSetDefaultRequest":{"type":"object","properties":{"kitKey":{"type":"string","minLength":1,"maxLength":160},"expectedVersion":{"type":"integer","minimum":0,"maximum":9007199254740991},"profileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kitKey","expectedVersion"],"additionalProperties":false},"AlphaBrandKitsSetDefaultResponse":{"type":"object","properties":{"kitKey":{"type":"string"},"profileId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"version":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["kitKey","profileId","version"],"additionalProperties":false},"AlphaBrandKitsRetireRequest":{"type":"object","properties":{"kitKey":{"type":"string","minLength":1,"maxLength":160},"expectedVersion":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["kitKey","expectedVersion"],"additionalProperties":false},"AlphaBrandKitsRetireResponse":{"type":"object","properties":{"kitKey":{"type":"string"},"version":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["kitKey","version"],"additionalProperties":false},"AlphaBrandKitAssetsReserveUploadRequest":{"type":"object","properties":{"kitKey":{"type":"string","minLength":1,"maxLength":160,"description":"The active kit the asset is for."},"role":{"type":"string","enum":["logo","logo_dark","icon","image","font_heading","font_body","screenshot","template","reference"]},"usage":{"type":"string","enum":["reference_only","web","embed","unavailable"]},"label":{"type":"string","minLength":1,"maxLength":160},"restriction":{"type":"string","minLength":1,"maxLength":500},"mediaType":{"type":"string","enum":["application/vnd.openxmlformats-officedocument.wordprocessingml.document","application/vnd.openxmlformats-officedocument.presentationml.presentation","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","application/pdf","application/vnd.openxmlformats-officedocument.presentationml.template","application/vnd.openxmlformats-officedocument.wordprocessingml.template","image/png","image/jpeg","image/webp","image/svg+xml","font/woff","font/woff2","font/ttf","font/otf"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":20971520,"description":"Exact size in bytes, at most 20 MiB."},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$","description":"Lowercase hex SHA-256 of the exact bytes you will upload."}},"required":["kitKey","role","usage","label","mediaType","byteLength","sha256"],"additionalProperties":false},"AlphaBrandKitAssetsReserveUploadResponse":{"type":"object","properties":{"asset":{"$ref":"#/components/schemas/AlphaBrandKitAssetsCompleteUploadResponse"},"upload":{"anyOf":[{"type":"object","properties":{"method":{"type":"string","const":"PUT"},"url":{"type":"string","format":"uri"},"headers":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"expiresAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["method","url","headers","expiresAt"],"additionalProperties":false},{"type":"null"}],"description":"Send the file as the body of exactly this request before expiresAt; the response body is JSON naming the stored file's etag. Null when the file was already uploaded: call alpha.brand-kit-assets.complete-upload.v1."}},"required":["asset","upload"],"additionalProperties":false},"AlphaBrandKitAssetsCompleteUploadRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The artifactId reserve-upload returned."},"etag":{"description":"The etag the upload's response named; omit to recover it from the store.","type":"string","minLength":1,"maxLength":1024}},"required":["id"],"additionalProperties":false},"AlphaBrandKitAssetsCompleteUploadResponse":{"type":"object","properties":{"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"role":{"type":"string","enum":["logo","logo_dark","icon","image","font_heading","font_body","screenshot","template","reference"]},"usage":{"type":"string","enum":["reference_only","web","embed","unavailable"]},"label":{"type":"string"},"restriction":{"type":"string"},"mediaType":{"type":"string","enum":["application/vnd.openxmlformats-officedocument.wordprocessingml.document","application/vnd.openxmlformats-officedocument.presentationml.presentation","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","application/pdf","application/vnd.openxmlformats-officedocument.presentationml.template","application/vnd.openxmlformats-officedocument.wordprocessingml.template","image/png","image/jpeg","image/webp","image/svg+xml","font/woff","font/woff2","font/ttf","font/otf"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"status":{"type":"string","enum":["pending","ready"],"description":"pending until alpha.brand-kit-assets.complete-upload.v1 proves the upload."}},"required":["artifactId","role","usage","label","mediaType","byteLength","status"],"additionalProperties":false},"AlphaBrandKitArtifactsDownloadResponse":{"type":"object","properties":{"filename":{"type":"string","minLength":1,"description":"Suggested file name for saving the bytes"},"contentType":{"type":"string","minLength":1},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Short-lived presigned URL that GETs the bytes; null when this deployment cannot sign the object"},"expiresAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}],"description":"When url stops working (minutes after the call); null with url"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["filename","contentType","byteLength","url","expiresAt","id"],"additionalProperties":false},"AlphaBrandKitImportsCreateRequest":{"type":"object","properties":{"kitKey":{"description":"The active kit the files are for. Give this or newKit, not both.","type":"string","minLength":1,"maxLength":160},"newKit":{"description":"Create a new kit for these files instead of naming one. It has no website: its colors, type and voice are read from the files, which then join it. Give this or kitKey, not both.","type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120,"description":"The new kit's name."}},"required":["name"],"additionalProperties":false},"files":{"minItems":1,"maxItems":64,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"The file's name, at most 255 characters. Control characters and bidirectional controls (U+202A–U+202E, U+2066–U+2069) are removed and the name is trimmed; the import answers the name it kept."},"mediaType":{"type":"string","enum":["application/vnd.openxmlformats-officedocument.wordprocessingml.document","application/vnd.openxmlformats-officedocument.presentationml.presentation","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","application/pdf","application/vnd.openxmlformats-officedocument.presentationml.template","application/vnd.openxmlformats-officedocument.wordprocessingml.template","image/png","image/jpeg","image/webp","image/svg+xml","font/woff","font/woff2","font/ttf","font/otf"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":20971520,"description":"Exact size in bytes, at most 20 MiB."},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$","description":"Lowercase hex SHA-256 of the exact bytes you will upload."}},"required":["name","mediaType","byteLength","sha256"],"additionalProperties":false}}},"required":["files"],"additionalProperties":false},"AlphaBrandKitImportsCreateResponse":{"type":"object","properties":{"importId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"kitKey":{"type":"string","minLength":1,"maxLength":160,"description":"The kit the files are for: the new kit, when one was named."},"serverTime":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$","description":"The server's clock when it answered. An upload's time left is its expiresAt less this, whatever your own clock says."},"files":{"type":"array","items":{"type":"object","properties":{"fileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"upload":{"anyOf":[{"type":"object","properties":{"method":{"type":"string","const":"PUT"},"url":{"type":"string","format":"uri"},"headers":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"expiresAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["method","url","headers","expiresAt"],"additionalProperties":false},{"type":"null"}],"description":"Send the file as the body of exactly this request before expiresAt. Null when the file is refused, already uploaded, or the import has started."},"refusal":{"anyOf":[{"type":"string","enum":["media_type_unsupported","size_invalid","kit_full","already_in_kit","kit_unavailable","not_uploaded","bytes_mismatch","template_hazard"]},{"type":"null"}],"description":"Why the file will not be added. A replay after start.v1 also answers what start refused."}},"required":["fileId","name","upload","refusal"],"additionalProperties":false}}},"required":["importId","kitKey","serverTime","files"],"additionalProperties":false},"AlphaBrandKitImportsStartRequest":{"type":"object","properties":{"importId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The importId create answered."}},"required":["importId"],"additionalProperties":false},"AlphaBrandKitImportsStartResponse":{"type":"object","properties":{"importId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"runId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The run identifying the files; null when no file was admitted, or the start was refused."},"status":{"type":"string","enum":["started","completed","refused"],"description":"started: the files are being identified. completed: nothing was left to identify. refused: the run was not admitted (see refusal); nothing was added."},"refusal":{"anyOf":[{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false},{"type":"null"}]},"files":{"type":"array","items":{"type":"object","properties":{"fileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"status":{"type":"string","enum":["uploading","identifying","added","needs_decision","refused"]},"refusal":{"anyOf":[{"type":"string","enum":["media_type_unsupported","size_invalid","kit_full","already_in_kit","kit_unavailable","not_uploaded","bytes_mismatch","template_hazard"]},{"type":"null"}]}},"required":["fileId","status","refusal"],"additionalProperties":false}}},"required":["importId","runId","status","refusal","files"],"additionalProperties":false},"AlphaBrandKitImportsGetResponse":{"type":"object","properties":{"importId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"kitKey":{"type":"string"},"status":{"type":"string","enum":["uploading","identifying","published","unchanged","failed"]},"runId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"revisionArtifactId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The one revision the import added its files in."},"version":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}],"description":"The kit version that revision was published at."},"restoreArtifactId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The revision before the import: restore it with alpha.brand-kits.restore.v1 to undo the import."},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Why a failed import did not finish, when it says more than its files do: for a kit with no published revision, why its brand could not be read from them."},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"completedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"files":{"$ref":"#/components/schemas/AlphaFiles"}},"required":["importId","kitKey","status","runId","revisionArtifactId","version","restoreArtifactId","error","createdAt","completedAt","files"],"additionalProperties":false},"AlphaBrandKitImportsListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/AlphaBrandKitImportsGetResponse"}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"AlphaCreativeActivitiesGetResponse":{"type":"object","properties":{"product":{"type":"string","enum":["studio","advisor","alpha","inspector"]},"reading":{"$ref":"#/components/schemas/InspectorReading"},"subject":{"anyOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["creative_project","conversation","scan"]},"id":{"type":"string","minLength":1},"name":{"type":"string"}},"required":["kind","id","name"],"additionalProperties":false},{"type":"null"}]},"observedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["product","reading","subject","observedAt"],"additionalProperties":false},"AlphaAdSuitesListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"language":{"type":"string"},"evidenceScope":{"type":"string"},"evidenceObservedAt":{"type":"string"},"sourceKind":{"type":"string","enum":["discovery_simulation","customer_supplied","observed_campaign","verified_business_fact","mixed"]},"brandKitArtifactId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"brandKit":{"anyOf":[{"type":"object","properties":{"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"kitKey":{"type":"string"},"name":{"type":"string"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["artifactId","kitKey","name","revision"],"additionalProperties":false},{"type":"null"}]},"reasons":{"type":"array","items":{"type":"object","properties":{"reasonId":{"type":"string"},"label":{"type":"string"}},"required":["reasonId","label"],"additionalProperties":false}},"concepts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"lossReason":{"type":"string"},"rationale":{"type":"string"},"reasonIds":{"type":"array","items":{"type":"string"}},"previewArtifactId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["id","name","lossReason","rationale","previewArtifactId"],"additionalProperties":false}},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"campaignId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"review":{"type":"string","enum":["draft","approved","changes_requested"]},"failureCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["id","name","language","evidenceScope","evidenceObservedAt","sourceKind","brandKitArtifactId","brandKit","reasons","concepts","version","campaignId","updatedAt","review","failureCount"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"lossReason":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"}},"required":["id","label"],"additionalProperties":false},{"type":"null"}]}},"required":["data","nextCursor","lossReason"],"additionalProperties":false},"AlphaAdSuitesGetResponse":{"type":"object","properties":{"suiteId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"campaignId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"versions":{"type":"array","items":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"revision":{"type":"object","properties":{"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"review":{"type":"string","enum":["draft","approved","changes_requested"]},"reviewNote":{"anyOf":[{"type":"string"},{"type":"null"}]},"brandKitArtifactId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"variantFailures":{"type":"array","items":{"type":"object","properties":{"variantId":{"type":"string","minLength":1},"message":{"type":"string","minLength":1,"maxLength":4000}},"required":["variantId","message"],"additionalProperties":false}},"renderFindings":{"anyOf":[{"type":"object","properties":{"findings":{"maxItems":256,"type":"array","items":{"$ref":"#/components/schemas/AlphaFindingsItem"}},"omitted":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["findings","omitted"],"additionalProperties":false},{"type":"null"}],"description":"What render_ad_set measured about each output (by variantId), kept as this revision's evidence; null for a revision saved before findings were kept"},"source":{"type":"object","properties":{"version":{"type":"number","const":1},"name":{"type":"string","minLength":1,"maxLength":160},"language":{"type":"string","minLength":1,"maxLength":35},"audience":{"type":"string","minLength":1,"maxLength":2000},"evidence":{"type":"object","properties":{"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"runIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"scope":{"type":"string","minLength":1,"maxLength":4000},"observedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"sourceKind":{"type":"string","enum":["discovery_simulation","customer_supplied","observed_campaign","verified_business_fact","mixed"]},"snapshotId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"metricScope":{"type":"object","properties":{"population":{"type":"string","minLength":1,"maxLength":2000},"dateFrom":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"dateTo":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"assistantLanes":{"type":"array","items":{"type":"string","minLength":1,"maxLength":160}},"filters":{"type":"array","items":{"type":"object","properties":{"dimension":{"type":"string","minLength":1,"maxLength":160},"values":{"type":"array","items":{"type":"string","minLength":1,"maxLength":500}}},"required":["dimension","values"],"additionalProperties":false}},"definition":{"type":"string","minLength":1,"maxLength":4000}},"required":["population","dateFrom","dateTo","assistantLanes","filters","definition"],"additionalProperties":false},"reasons":{"type":"array","items":{"type":"object","properties":{"reasonId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"label":{"type":"string","minLength":1,"maxLength":2000},"count":{"type":"integer","minimum":0,"maximum":9007199254740991},"metric":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":160},"definition":{"type":"string","minLength":1,"maxLength":2000},"unit":{"type":"string","minLength":1,"maxLength":120}},"required":["key","definition","unit"],"additionalProperties":false},"denominator":{"type":"object","properties":{"count":{"type":"integer","minimum":0,"maximum":9007199254740991},"metric":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":160},"definition":{"type":"string","minLength":1,"maxLength":2000},"unit":{"type":"string","minLength":1,"maxLength":120}},"required":["key","definition","unit"],"additionalProperties":false}},"required":["count","metric"],"additionalProperties":false},"sources":{"type":"array","items":{"type":"object","properties":{"sourceId":{"type":"string","minLength":1,"maxLength":160},"kind":{"type":"string","minLength":1,"maxLength":120},"label":{"type":"string","minLength":1,"maxLength":1000},"url":{"type":"string","maxLength":2048,"format":"uri"},"href":{"type":"string","maxLength":2048,"pattern":"^\\/app\\/.*"}},"required":["sourceId","kind","label"],"additionalProperties":false}}},"required":["reasonId","label","count","metric","sources"],"additionalProperties":false}}},"required":["runIds","scope","observedAt","sourceKind"],"additionalProperties":false},"outcome":{"type":"string","enum":["proposed","no_supported_concepts"]},"explanation":{"type":"string","minLength":1,"maxLength":4000},"placementReferences":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":80},"channel":{"type":"string","minLength":1,"maxLength":160},"format":{"type":"string","minLength":1,"maxLength":160},"sourceUrl":{"type":"string","maxLength":2048,"format":"uri"},"verifiedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"requirements":{"type":"array","items":{"type":"string","minLength":1,"maxLength":2000}}},"required":["id","channel","format","sourceUrl","verifiedAt","requirements"],"additionalProperties":false}},"deliverables":{"type":"array","items":{"type":"object","properties":{"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$"},"title":{"type":"string","minLength":1,"maxLength":240},"role":{"type":"string","enum":["landing_page","landing_page_change","test_plan","brief"]},"conceptIds":{"type":"array","items":{"type":"string","minLength":1,"maxLength":80}},"dependsOn":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"evidenceIds":{"maxItems":128,"type":"array","items":{"type":"string","minLength":1,"maxLength":400}}},"required":["artifactId","title","role","conceptIds","dependsOn"],"additionalProperties":false}},"testPlans":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":80},"conceptIds":{"type":"array","items":{"type":"string","minLength":1,"maxLength":80}},"hypothesis":{"type":"string","minLength":1,"maxLength":4000},"comparison":{"type":"string","minLength":1,"maxLength":4000},"primaryOutcome":{"type":"string","minLength":1,"maxLength":2000},"measurementPrerequisites":{"type":"array","items":{"type":"string","minLength":1,"maxLength":2000}},"observationWindow":{"type":"string","minLength":1,"maxLength":2000},"interpretationLimits":{"type":"array","items":{"type":"string","minLength":1,"maxLength":2000}},"readiness":{"type":"string","enum":["not_connected","prerequisites_missing","ready_for_authorized_test"]},"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["id","conceptIds","hypothesis","comparison","primaryOutcome","measurementPrerequisites","observationWindow","interpretationLimits","readiness"],"additionalProperties":false}},"unresolvedReasons":{"type":"array","items":{"type":"object","properties":{"reasonId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"explanation":{"type":"string","minLength":1,"maxLength":4000},"recommendedAction":{"type":"string","minLength":1,"maxLength":4000}},"required":["reasonId","explanation","recommendedAction"],"additionalProperties":false}},"concepts":{"maxItems":6,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":80},"name":{"type":"string","minLength":1,"maxLength":160},"lossReason":{"type":"string","minLength":1,"maxLength":2000},"reasonIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"rationale":{"type":"string","minLength":1,"maxLength":4000},"beliefChange":{"type":"string","minLength":1,"maxLength":4000},"creativeDirection":{"type":"string","minLength":1,"maxLength":4000},"proofRequests":{"type":"array","items":{"type":"string","minLength":1,"maxLength":2000}},"hypothesis":{"type":"string","minLength":1,"maxLength":2000},"claim":{"type":"string","minLength":1,"maxLength":2000},"proof":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":2000},"url":{"type":"string","maxLength":2048,"format":"uri"},"sourceId":{"type":"string","minLength":1,"maxLength":160}},"required":["label"],"additionalProperties":false}},"limitations":{"type":"array","items":{"type":"string","minLength":1,"maxLength":2000}},"searchAds":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":80},"placementReferenceId":{"type":"string","minLength":1,"maxLength":80},"headlines":{"minItems":1,"type":"array","items":{"type":"object","properties":{"text":{"type":"string","minLength":1,"maxLength":500},"pin":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["text"],"additionalProperties":false}},"descriptions":{"minItems":1,"type":"array","items":{"type":"object","properties":{"text":{"type":"string","minLength":1,"maxLength":500},"pin":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["text"],"additionalProperties":false}},"path":{"type":"array","items":{"type":"string","minLength":1,"maxLength":160}},"finalUrl":{"type":"string","maxLength":2048,"format":"uri"}},"required":["id","placementReferenceId","headlines","descriptions","path","finalUrl"],"additionalProperties":false}},"responsiveDisplay":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":80},"placementReferenceId":{"type":"string","minLength":1,"maxLength":80},"images":{"minItems":1,"maxItems":16,"type":"array","items":{"type":"object","properties":{"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"altText":{"type":"string","minLength":1,"maxLength":2000},"aspectRatio":{"type":"string","minLength":1,"maxLength":80}},"required":["artifactId","altText","aspectRatio"],"additionalProperties":false}},"logos":{"maxItems":8,"type":"array","items":{"type":"object","properties":{"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"altText":{"type":"string","minLength":1,"maxLength":2000},"aspectRatio":{"type":"string","minLength":1,"maxLength":80}},"required":["artifactId","altText","aspectRatio"],"additionalProperties":false}},"businessName":{"type":"string","minLength":1,"maxLength":160},"headlines":{"minItems":1,"type":"array","items":{"type":"string","minLength":1,"maxLength":500}},"longHeadline":{"type":"string","minLength":1,"maxLength":500},"descriptions":{"minItems":1,"type":"array","items":{"type":"string","minLength":1,"maxLength":2000}},"callToAction":{"type":"string","minLength":1,"maxLength":120},"finalUrl":{"type":"string","maxLength":2048,"format":"uri"}},"required":["id","placementReferenceId","images","logos","businessName","headlines","longHeadline","descriptions","callToAction","finalUrl"],"additionalProperties":false}},"variants":{"maxItems":8,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":80},"placement":{"type":"string","minLength":1,"maxLength":160},"placementReferenceId":{"description":"A placement preset id, or the id of one of this suite's placementReferences for a placement no preset covers.","type":"string","minLength":1,"maxLength":80},"altText":{"type":"string","minLength":1,"maxLength":2000},"safeArea":{"description":"Insets in pixels that the platform's interface can cover. A preset with a safe zone supplies it when omitted.","type":"object","properties":{"top":{"type":"integer","minimum":0,"maximum":9007199254740991},"right":{"type":"integer","minimum":0,"maximum":9007199254740991},"bottom":{"type":"integer","minimum":0,"maximum":9007199254740991},"left":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["top","right","bottom","left"],"additionalProperties":false},"headline":{"type":"string","minLength":1,"maxLength":500},"body":{"type":"string","maxLength":5000},"callToAction":{"type":"string","minLength":1,"maxLength":120},"destinationUrl":{"type":"string","maxLength":2048,"format":"uri"},"composition":{"type":"object","properties":{"width":{"type":"integer","exclusiveMinimum":0,"maximum":4096},"height":{"type":"integer","exclusiveMinimum":0,"maximum":4096},"background":{"type":"string","pattern":"^#[a-fA-F0-9]{6}$"},"layers":{"maxItems":64,"type":"array","items":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"shape"},"id":{"description":"Optional name for this layer, unique in its composition. Findings cite it.","type":"string","minLength":1,"maxLength":80},"x":{"type":"integer","minimum":0,"maximum":9007199254740991},"y":{"type":"integer","minimum":0,"maximum":9007199254740991},"width":{"type":"integer","exclusiveMinimum":0,"maximum":4096},"height":{"type":"integer","exclusiveMinimum":0,"maximum":4096},"opacity":{"description":"The whole layer's opacity, 0 (transparent) to 1 (opaque, the default).","type":"number","minimum":0,"maximum":1},"color":{"type":"string","pattern":"^#[a-fA-F0-9]{6}$","description":"Solid fill. A gradient, when given, paints instead."},"radius":{"default":0,"type":"integer","minimum":0,"maximum":9007199254740991},"gradient":{"description":"A two-color linear gradient that fills the shape instead of color.","type":"object","properties":{"angle":{"type":"number","minimum":0,"maximum":360,"description":"Degrees, as CSS linear-gradient: 0 runs bottom to top, 90 left to right, 180 top to bottom."},"from":{"type":"string","pattern":"^#[a-fA-F0-9]{6}$","description":"The color where the gradient starts."},"to":{"type":"string","pattern":"^#[a-fA-F0-9]{6}$","description":"The color where the gradient ends."},"fromOpacity":{"description":"Opacity at the start, 0 to 1 (default 1).","type":"number","minimum":0,"maximum":1},"toOpacity":{"description":"Opacity at the end, 0 to 1 (default 1).","type":"number","minimum":0,"maximum":1}},"required":["angle","from","to"],"additionalProperties":false},"shadow":{"description":"A drop shadow the shape casts, as CSS box-shadow: offset and blur radius in pixels, clipped to the canvas.","type":"object","properties":{"x":{"type":"integer","minimum":-256,"maximum":256},"y":{"type":"integer","minimum":-256,"maximum":256},"blur":{"type":"integer","minimum":0,"maximum":128},"color":{"type":"string","pattern":"^#[a-fA-F0-9]{6}$"},"opacity":{"type":"number","minimum":0,"maximum":1}},"required":["x","y","blur","color","opacity"],"additionalProperties":false}},"required":["kind","x","y","width","height","color","radius"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"image"},"id":{"description":"Optional name for this layer, unique in its composition. Findings cite it.","type":"string","minLength":1,"maxLength":80},"x":{"type":"integer","minimum":0,"maximum":9007199254740991},"y":{"type":"integer","minimum":0,"maximum":9007199254740991},"width":{"type":"integer","exclusiveMinimum":0,"maximum":4096},"height":{"type":"integer","exclusiveMinimum":0,"maximum":4096},"opacity":{"description":"The whole layer's opacity, 0 (transparent) to 1 (opaque, the default).","type":"number","minimum":0,"maximum":1},"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"fit":{"type":"string","enum":["cover","contain"]},"focus":{"description":"Cover only: the point of the source image, 0 to 1 from its left and top edges, that the crop keeps as near the layer's centre as the image allows. The centre when omitted.","type":"object","properties":{"x":{"type":"number","minimum":0,"maximum":1},"y":{"type":"number","minimum":0,"maximum":1}},"required":["x","y"],"additionalProperties":false}},"required":["kind","x","y","width","height","artifactId","fit"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"text"},"id":{"description":"Optional name for this layer, unique in its composition. Findings cite it.","type":"string","minLength":1,"maxLength":80},"x":{"type":"integer","minimum":0,"maximum":9007199254740991},"y":{"type":"integer","minimum":0,"maximum":9007199254740991},"width":{"type":"integer","exclusiveMinimum":0,"maximum":4096},"height":{"type":"integer","exclusiveMinimum":0,"maximum":4096},"opacity":{"description":"The whole layer's opacity, 0 (transparent) to 1 (opaque, the default).","type":"number","minimum":0,"maximum":1},"lines":{"minItems":1,"maxItems":32,"type":"array","items":{"type":"string","minLength":1,"maxLength":500,"pattern":"^[^\\r\\n\\u000B\\u000C\\u0085\\u2028\\u2029]*$"}},"fontSize":{"type":"integer","exclusiveMinimum":0,"maximum":512},"lineHeight":{"type":"number","exclusiveMinimum":0,"maximum":4},"color":{"type":"string","pattern":"^#[a-fA-F0-9]{6}$"},"weight":{"type":"string","enum":["normal","bold"]},"align":{"type":"string","enum":["left","center","right"]},"fit":{"description":"Opt in to shrinking: when these lines overflow the layer at fontSize, they render at the largest whole size down to minFontSize that fits, and the result reports the size used. Without it, overflowing text is clipped and reported.","type":"object","properties":{"mode":{"type":"string","const":"shrink"},"minFontSize":{"type":"integer","exclusiveMinimum":0,"maximum":512}},"required":["mode","minFontSize"],"additionalProperties":false},"fontArtifactId":{"description":"Approved Brand Kit font resource ID (a font_heading or font_body asset of the kit revision this suite is bound to). The placement renders in that font when the file can draw every character of this layer's copy in this layer's weight; otherwise it renders in the bundled Geist family and the reason is recorded beside the layer. Never pass a family name, a URL or font bytes.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"fontFallback":{"description":"Reserved for the renderer's record of an unusable brand font. Do not set it.","type":"object","properties":{"requested":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"reason":{"type":"string","enum":["not_approved","missing_glyphs","weight_unavailable","isolated_renderer_unavailable"]},"family":{"type":"string","const":"Geist"}},"required":["requested","reason","family"],"additionalProperties":false},"fontSubstitute":{"description":"Reserved for the renderer's record of the open face that stood in for the kit's proprietary family. Do not set it.","type":"object","properties":{"family":{"type":"string","minLength":1,"maxLength":200},"substitute":{"type":"string","enum":["Arimo","Carlito","Caladea","Jost","EB Garamond","Gelasio","Tinos","DejaVu Sans"]}},"required":["family","substitute"],"additionalProperties":false}},"required":["kind","x","y","width","height","lines","fontSize","lineHeight","color","weight","align"],"additionalProperties":false}]}}},"required":["width","height","background","layers"],"additionalProperties":false}},"required":["id","placement","headline","body","callToAction","destinationUrl","composition"],"additionalProperties":false}}},"required":["id","name","lossReason","rationale","hypothesis","claim","proof","limitations","variants"],"additionalProperties":false}}},"required":["version","name","language","audience","evidence","outcome","explanation","concepts"],"additionalProperties":false}},"required":["revision","review","reviewNote","brandKitArtifactId","variantFailures","renderFindings","source"],"additionalProperties":false},"assets":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"role":{"type":"string","enum":["variant","source","deliverable"]},"url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"A five-minute presigned read of the file's bytes; null when none could be issued"},"urlExpiresAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}],"description":"When `url` stops working"}},"required":["key","artifactId","role","url","urlExpiresAt"],"additionalProperties":false}},"reviewEvents":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"decision":{"type":"string","enum":["approved","changes_requested"]},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["id","decision","note","createdAt"],"additionalProperties":false}},"brandKit":{"anyOf":[{"type":"object","properties":{"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"kitKey":{"type":"string"},"name":{"type":"string"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["artifactId","kitKey","name","revision"],"additionalProperties":false},{"type":"null"}]},"currentRunId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The newest Discovery run that measured a conversation of the suite's campaign's results window as of now; when it is not among the evidence's runIds, newer evidence exists"},"googleAdsDrafts":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customerId":{"type":"string"},"accountName":{"anyOf":[{"type":"string"},{"type":"null"}]},"currencyCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"syncedThrough":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The last account-local day synced"},"adGroupId":{"type":"string"},"adId":{"type":"string"},"adType":{"type":"string","enum":["responsive_search","responsive_display"]},"suiteRevision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"conceptId":{"type":"string"},"suiteAdId":{"type":"string","description":"The searchAds or responsiveDisplay id it was built from"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"daysWithData":{"type":"integer","minimum":0,"maximum":9007199254740991},"firstDate":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastDate":{"anyOf":[{"type":"string"},{"type":"null"}]},"impressions":{"type":"number","minimum":0},"clicks":{"type":"number","minimum":0},"conversions":{"type":"number","minimum":0},"costMicros":{"type":"number","minimum":0}},"required":["accountId","customerId","accountName","currencyCode","syncedThrough","adGroupId","adId","adType","suiteRevision","conceptId","suiteAdId","createdAt","daysWithData","firstDate","lastDate","impressions","clicks","conversions","costMicros"],"additionalProperties":false},"description":"Every paused Google ad Point11 created from any revision of this suite, with Google's impressions, clicks, conversions, and cost (micros of the account's currency) summed over the synced days; empty when none was created"}},"required":["suiteId","campaignId","version","versions","revision","assets","reviewEvents","brandKit","currentRunId","googleAdsDrafts"],"additionalProperties":false},"AlphaAdSuitesReviewRequest":{"type":"object","properties":{"suiteId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"review":{"type":"string","enum":["approved","changes_requested"]},"note":{"type":"string","maxLength":4000}},"required":["suiteId","revision","review"],"additionalProperties":false},"AlphaAdSuitesReviewResponse":{"type":"object","properties":{"suiteId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"review":{"type":"string","enum":["approved","changes_requested"]}},"required":["suiteId","revision","review"],"additionalProperties":false},"AlphaAdSuiteAssetsDownloadResponse":{"type":"object","properties":{"filename":{"type":"string","minLength":1,"description":"Suggested file name for saving the bytes"},"contentType":{"type":"string","minLength":1},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Short-lived presigned URL that GETs the bytes; null when this deployment cannot sign the object"},"expiresAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}],"description":"When url stops working (minutes after the call); null with url"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["filename","contentType","byteLength","url","expiresAt","id"],"additionalProperties":false},"AlphaAdSuitesExportResponse":{"type":"object","properties":{"filename":{"type":"string","minLength":1,"description":"Suggested name for the assembled .zip"},"entries":{"$ref":"#/components/schemas/AlphaEntries"}},"required":["filename","entries"],"additionalProperties":false},"AlphaAdBootstrapsListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"campaignKey":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"phase":{"type":"string","enum":["waiting_for_evidence","preparing","needs_brand_choice","creating","created","needs_recovery"]},"language":{"type":"string"},"package":{"anyOf":[{"type":"object","properties":{"channels":{"minItems":1,"type":"array","items":{"type":"string","enum":["meta","google_search","google_display"]}},"deliverables":{"minItems":1,"type":"array","items":{"type":"string","enum":["static","search","responsive_display","landing_page","test_plan"]}}},"required":["channels","deliverables"],"additionalProperties":false},{"type":"null"}]},"brand":{"oneOf":[{"type":"object","properties":{"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"kind":{"type":"string","const":"pinned"}},"required":["artifactId","name","kind"],"additionalProperties":false},{"type":"object","properties":{"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"kind":{"type":"string","const":"selected"}},"required":["artifactId","name","kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unbranded"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"none"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"pending"}},"required":["kind"],"additionalProperties":false}]},"brandIssue":{"anyOf":[{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"extraction_failed"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"extraction_unavailable"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["kind","reason"],"additionalProperties":false}]},{"type":"null"}]},"needsBrandChoice":{"type":"boolean"},"canRecover":{"type":"boolean"},"runId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"suiteId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"suiteRevision":{"anyOf":[{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},{"type":"null"}]},"threadId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["campaignId","campaignKey","name","phase","language","package","brand","brandIssue","needsBrandChoice","canRecover","runId","suiteId","suiteRevision","threadId"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"AlphaAdBootstrapsChooseBrandRequest":{"type":"object","properties":{"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"choice":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"unbranded"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"brand_kit"},"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","artifactId"],"additionalProperties":false}]}},"required":["campaignId","choice"],"additionalProperties":false},"AlphaAdBootstrapsChooseBrandResponse":{"type":"object","properties":{"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["campaignId"],"additionalProperties":false},"AlphaAdBootstrapsRecoverRequest":{"type":"object","properties":{"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["campaignId"],"additionalProperties":false},"AlphaAdBootstrapsRecoverResponse":{"type":"object","properties":{"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["campaignId"],"additionalProperties":false},"AlphaAdvisorActionsListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/AlphaDataItem"}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"totalCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Actions matching the campaign, status, area, and query filters across every page"},"status":{"type":"string","enum":["open","completed","dismissed","all"],"description":"The status the list shows: the one named, else the named action's, else open"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"This page's own position, to come back to it: the cursor that reads it again; null on the first page"},"trail":{"type":"array","items":{"type":"string"},"description":"Where a named action opened the page (`actionId`), the cursor that reads each page from the second through this one, oldest first, so a pager steps back to each; its last is `cursor`. Empty on the first page and on a page read after a cursor, whose caller holds its own trail"},"campaign":{"$ref":"#/components/schemas/AlphaCampaign"},"campaigns":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"product":{"type":"string","enum":["discovery","experience"],"description":"The product whose campaign it is"},"dispatchId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The campaign's newest publication (a Discovery dispatch or an Experience cycle); create.v1 and create.v2 accept it and no longer read it"}},"required":["id","name","product","dispatchId"],"additionalProperties":false},"description":"Every campaign the list can be scoped to, by name"},"reviewedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}],"description":"When the Advisor review the list is ordered by published; null before the organization's first review"}},"required":["data","nextCursor","totalCount","status","cursor","trail","campaign","campaigns","reviewedAt"],"additionalProperties":false},"AlphaAdvisorActionsListV2Response":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/AlphaDataItem2"}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"totalCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Actions matching the campaign, status, area, and query filters across every page"},"status":{"type":"string","enum":["open","completed","dismissed","all"],"description":"The status the list shows: the one named, else the named action's, else open"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"This page's own position, to come back to it: the cursor that reads it again; null on the first page"},"trail":{"type":"array","items":{"type":"string"},"description":"Where a named action opened the page (`actionId`), the cursor that reads each page from the second through this one, oldest first, so a pager steps back to each; its last is `cursor`. Empty on the first page and on a page read after a cursor, whose caller holds its own trail"},"campaign":{"$ref":"#/components/schemas/AlphaCampaign"},"campaigns":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"product":{"type":"string","enum":["discovery","experience"],"description":"The product whose campaign it is"},"dispatchId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The campaign's newest publication (a Discovery dispatch or an Experience cycle); create.v1 and create.v2 accept it and no longer read it"}},"required":["id","name","product","dispatchId"],"additionalProperties":false},"description":"Every campaign the list can be scoped to, by name"},"reviewedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}],"description":"When the Advisor review the list is ordered by published; null before the organization's first review"}},"required":["data","nextCursor","totalCount","status","cursor","trail","campaign","campaigns","reviewedAt"],"additionalProperties":false},"AlphaAdvisorActionsListV3Response":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/AlphaDataItem3"}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"totalCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Listed actions the filters match across every page"},"review":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"state":{"type":"string","enum":["running","published","failed","stale"]},"completedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"canRetry":{"type":"boolean","description":"It failed, so alpha.advisor-reviews.run.v1 runs it again"},"owed":{"type":"boolean","description":"Another review is owed after this one (a trigger came while it ran, or it settled stale) and runs next"}},"required":["id","state","completedAt","canRetry","owed"],"additionalProperties":false},{"type":"null"}],"description":"The organization's newest review; null before its first"},"publishedReview":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"completedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["id","completedAt"],"additionalProperties":false},{"type":"null"}],"description":"The review whose order the list shows (Advisor as of its completedAt); null before the first published"},"metricLabels":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"description":"The short words each metric an action may target reads as, its owner's label (e.g. discovery:discovery_brand_win_rate reads win rate), keyed <product>:<metric> as an expected effect's product and metric and an outcome's metric name it; a metric it does not name reads as its name"}},"required":["data","nextCursor","totalCount","review","publishedReview","metricLabels"],"additionalProperties":false},"AlphaAdvisorActionsGetResponse":{"type":"object","properties":{"action":{"$ref":"#/components/schemas/AlphaDataItem"},"history":{"$ref":"#/components/schemas/AlphaHistory"},"files":{"$ref":"#/components/schemas/AlphaFiles2"},"measuredAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$","description":"When the action's current content was written"},"frozenRun":{"anyOf":[{"type":"object","properties":{"dispatchId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ranAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["dispatchId","ranAt"],"additionalProperties":false},{"type":"null"}],"description":"Null: a conversation's frozen evidence is the action's revision and evidence links, not one product run"}},"required":["action","history","files","measuredAt","frozenRun"],"additionalProperties":false},"AlphaAdvisorActionsGetV2Response":{"type":"object","properties":{"action":{"$ref":"#/components/schemas/AlphaDataItem2"},"history":{"$ref":"#/components/schemas/AlphaHistory"},"files":{"$ref":"#/components/schemas/AlphaFiles2"},"measuredAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$","description":"When the action's current content was written"},"frozenRun":{"anyOf":[{"type":"object","properties":{"dispatchId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ranAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["dispatchId","ranAt"],"additionalProperties":false},{"type":"null"}],"description":"Null: a conversation's frozen evidence is the action's revision and evidence links, not one product run"}},"required":["action","history","files","measuredAt","frozenRun"],"additionalProperties":false},"AlphaAdvisorActionsGetV3Response":{"type":"object","properties":{"action":{"$ref":"#/components/schemas/AlphaDataItem3"},"revisions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ordinal":{"type":"integer","minimum":1,"maximum":9007199254740991},"authorKind":{"type":"string","enum":["person","api_key","automation","review","unknown"]},"authorId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The member's user id or the API key's id"},"reviewId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The review that wrote it"},"content":{"$ref":"#/components/schemas/AlphaContent"},"valueUsd":{"anyOf":[{"type":"number"},{"type":"null"}]},"valueBasis":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/JsonValue"}},{"type":"null"}],"description":"How valueUsd was computed: the metric, the campaign (campaignId) or site (site) and publication priced, the estimate in points (estimatePp), the revenue lines its effect names (revenueLineIds; lines, each with its name, point and AI-influenced sales) and their points added up (pointValueUsd); or why it has none (unpriced)"},"citations":{"type":"array","items":{"type":"object","properties":{"start":{"type":"integer","minimum":0,"maximum":9007199254740991},"end":{"type":"integer","minimum":0,"maximum":9007199254740991},"rows":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"product":{"type":"string","enum":["discovery","experience","inspector"]},"dataset":{"type":"string","minLength":1,"maxLength":100},"rowId":{"type":"string","minLength":1,"maxLength":300},"publicationId":{"type":"string","minLength":1,"maxLength":300}},"required":["product","dataset","rowId","publicationId"],"additionalProperties":false}}},"required":["start","end","rows"],"additionalProperties":false},"description":"Where each figure of a review-written body landed (start and end, in UTF-16 code units) and the evidence rows it rests on, each one of the action's links; empty for a person's revision"},"findings":{"$ref":"#/components/schemas/AlphaFindings"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["id","ordinal","authorKind","authorId","reviewId","content","valueUsd","valueBasis","citations","findings","createdAt"],"additionalProperties":false}},"events":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"actorKind":{"type":"string","enum":["person","api_key","automation","review","unknown"]},"actorId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The member's user id or the API key's id"},"actorName":{"description":"The member's name, while they are one","type":"string"},"runId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The review or website check that made it"},"type":{"type":"string","enum":["created","revised","state","disposition","evidence","control","note","suggestion"]},"fromValue":{"anyOf":[{"type":"string"},{"type":"null"}]},"toValue":{"anyOf":[{"type":"string"},{"type":"null"}]},"reason":{"anyOf":[{"type":"string","maxLength":4000},{"type":"null"}],"description":"A dismissal reason, a note, or a review's why for a status change, a withdrawal or a placement"},"revisionAfter":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["id","at","actorKind","actorId","runId","type","fromValue","toValue","reason","revisionAfter"],"additionalProperties":false}},"evidence":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"product":{"type":"string","enum":["discovery","experience","inspector"]},"dataset":{"type":"string"},"rowId":{"type":"string"},"publicationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"subjectId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The campaign (or site) its publication measured"},"claim":{"anyOf":[{"type":"string"},{"type":"null"}]},"introducedByEventId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"withdrawnByEventId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"href":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The page its row is seen on, as the link recorded it; null where it recorded none"}},"required":["id","product","dataset","rowId","publicationId","subjectId","claim","introducedByEventId","withdrawnByEventId","href"],"additionalProperties":false}},"outcomes":{"type":"array","items":{"$ref":"#/components/schemas/AlphaLatestOutcomeVariant"}}},"required":["action","revisions","events","evidence","outcomes"],"additionalProperties":false},"AlphaAdvisorActionsCreateRequest":{"type":"object","properties":{"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"dispatchId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Accepted and no longer read"},"title":{"type":"string","minLength":1,"maxLength":140},"context":{"type":"string","minLength":1,"maxLength":500},"area":{"type":"string","enum":["product","content","distribution","pricing_packaging","compliance_security","sales_enablement","competitive_positioning","customer_success","operations"]},"effortLevel":{"default":"medium","type":"string","enum":["low","medium","high"]},"evidenceSummary":{"type":"string","minLength":1,"maxLength":700}},"required":["campaignId","dispatchId","title","context","area","evidenceSummary"],"additionalProperties":false,"deprecated":true},"AlphaAdvisorActionsCreateResponse":{"type":"object","properties":{"action":{"$ref":"#/components/schemas/AlphaDataItem"}},"required":["action"],"additionalProperties":false},"AlphaAdvisorActionsCreateV2Request":{"type":"object","properties":{"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"dispatchId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Accepted and no longer read"},"title":{"type":"string","minLength":1,"maxLength":140},"context":{"type":"string","minLength":1,"maxLength":500},"area":{"type":"string","enum":["product","content","distribution","pricing_packaging","compliance_security","sales_enablement","competitive_positioning","customer_success","operations"]},"effortLevel":{"default":"medium","type":"string","enum":["low","medium","high"]},"evidenceSummary":{"type":"string","minLength":1,"maxLength":700}},"required":["campaignId","dispatchId","title","context","area","evidenceSummary"],"additionalProperties":false,"deprecated":true},"AlphaAdvisorActionsCreateV2Response":{"type":"object","properties":{"action":{"$ref":"#/components/schemas/AlphaDataItem2"}},"required":["action"],"additionalProperties":false},"AlphaAdvisorActionsCreateV3Request":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":300,"description":"What to do, in a few words"},"body":{"type":"string","minLength":1,"maxLength":8000,"description":"Why: the evidence-backed rationale"},"action":{"type":"string","maxLength":4000,"description":"What to do, in detail; may be empty"},"area":{"type":"string","enum":["product","content","distribution","pricing_packaging","compliance_security","sales_enablement","competitive_positioning","customer_success","operations"]},"effort":{"type":"string","enum":["low","medium","high"]},"subject":{"$ref":"#/components/schemas/AlphaSubject"},"expectedEffect":{"description":"What it is expected to move, on a metric an evidence product declares","anyOf":[{"type":"object","properties":{"product":{"type":"string","enum":["discovery","experience","inspector"]},"metric":{"type":"string","maxLength":100,"pattern":"^[a-z][a-z0-9]*(?:_[a-z0-9]+)*$"},"unit":{"type":"string","enum":["pp","count","ratio","usd"]},"horizon":{"type":"string","maxLength":200},"estimate":{"anyOf":[{"type":"number"},{"type":"null"}]},"low":{"anyOf":[{"type":"number"},{"type":"null"}]},"high":{"anyOf":[{"type":"number"},{"type":"null"}]},"assumptions":{"type":"string","maxLength":2000},"revenueLineIds":{"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":200}}},"required":["product","metric","unit","horizon","estimate","low","high","assumptions"],"additionalProperties":false},{"type":"null"}]},"completionCriteria":{"description":"How to tell it is done; autotracking writes its own when none are given","anyOf":[{"maxItems":20,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$","description":"A short stable key, e.g. walk_in_hours_clinic_a"},"requirement":{"type":"string","minLength":1,"maxLength":400,"description":"What must be visible on the public site, in one sentence"},"scope":{"type":"string","minLength":1,"maxLength":300,"description":"Where it must be visible: which pages, locations, or plans"}},"required":["id","requirement","scope"]}},{"type":"null"}]}},"required":["title","body","action","area","effort"],"additionalProperties":false},"AlphaAdvisorActionsCreateV3Response":{"type":"object","properties":{"action":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"section":{"anyOf":[{"type":"string","enum":["awaiting_review","listed","set_aside"]},{"type":"null"}],"description":"awaiting_review: open and not yet ordered by the published review (new or changed since it read the list), or any action before the first review; listed: on its order, or, with no position, done or dismissed and not placed by it; set_aside: set aside by an older review, until a review places it again. Null when the action is off the list (retired or merged by an older review, or every live evidence link's campaign has left)"},"position":{"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"null"}],"description":"Its place in the published review's order; null while awaiting review, once done or dismissed and not placed by it, or off the list"},"why":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The published review's one sentence why it is placed so"},"reviewId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The published review that placed it"},"state":{"type":"string","enum":["acknowledged","in_progress","done","dismissed"],"description":"acknowledged is Open; done is Completed"},"status":{"type":"string","enum":["open","completed","dismissed"]},"statusControl":{"type":"string","enum":["automatic","manual"],"description":"automatic: a review may revise or dismiss it; manual: a person or API key set it, and a review never revises or dismisses it. A review may complete, reopen or resurface either"},"disposition":{"type":"string","enum":["active","set_aside","retired","merged"]},"mergedIntoId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The action an older review merged it into"},"actionRevision":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Advances with every change; update.v2's expectedRevision names it"},"revision":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ordinal":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["id","ordinal"],"additionalProperties":false,"description":"Its current content revision"},"content":{"$ref":"#/components/schemas/AlphaContent"},"valueUsd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The opportunity its expected effect stands for a year on the revenue lines it names, where Advisor priced it: on a campaign, a share of those lines' AI-influenced market, not the company's revenue, so it can exceed the brand's own sales; on a site Inspector measures, the brand's own sales on those lines that its mobile speed moves"},"valueUnpriced":{"anyOf":[{"type":"string","enum":["no_expected_effect","no_estimate","not_an_increase","unit_unpriced","metric_unpriced","no_campaign","not_measured","no_revenue_economics"]},{"type":"null"}],"description":"Why it has no dollar value, where a review said: no_expected_effect, no_estimate, not_an_increase, unit_unpriced, metric_unpriced (no owner prices its metric), no_campaign, not_measured (nothing measured on its campaign yet to price it), or no_revenue_economics (its campaign's revenue lines have no Revenue Tracking economics); null when priced or unsaid, and when its effect names none of its campaign's priced revenue lines (its revision's valueBasis.unpriced says no_revenue_line)"},"findings":{"$ref":"#/components/schemas/AlphaFindings"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"createdByKind":{"anyOf":[{"type":"string","enum":["person","api_key","automation","review","unknown"]},{"type":"null"}]},"firstSuggestedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"lastStateChangeAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"dismissedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"dismissalReason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Why it was dismissed; null when dismissed without a reason, or not dismissed"},"latestStateChange":{"$ref":"#/components/schemas/AlphaLatestStateChange"},"implementation":{"$ref":"#/components/schemas/AlphaImplementation2"},"latestOutcome":{"$ref":"#/components/schemas/AlphaLatestOutcome"},"conversation":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The action's Ship with Alpha conversation"},"failed":{"type":"boolean","description":"Its latest turn failed (a stop is not a failure)"}},"required":["id","failed"],"additionalProperties":false},{"type":"null"}]}},"required":["id","section","position","why","reviewId","state","status","statusControl","disposition","mergedIntoId","actionRevision","revision","content","valueUsd","valueUnpriced","findings","createdAt","createdByKind","firstSuggestedAt","lastStateChangeAt","dismissedAt","dismissalReason","latestStateChange","implementation","latestOutcome","conversation"],"additionalProperties":false,"description":"The created action, as get.v3 reads it"}},"required":["action"],"additionalProperties":false},"AlphaAdvisorActionsUpdateRequest":{"type":"object","properties":{"actionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"state":{"description":"acknowledged is Open; done is Completed","type":"string","enum":["acknowledged","in_progress","done","dismissed"]},"dismissalReason":{"type":"string","minLength":1,"maxLength":500},"note":{"type":"string","minLength":1,"maxLength":1000},"applyToGroup":{"description":"Accepted and not read: Advisor no longer groups actions","type":"boolean"}},"required":["actionId"],"additionalProperties":false,"deprecated":true},"AlphaAdvisorActionsUpdateResponse":{"type":"object","properties":{"action":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"status":{"type":"string","enum":["acknowledged","in_progress","done","dismissed"]}},"required":["id","status"],"additionalProperties":false},"historyEntryId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"group":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"status":{"type":"string","enum":["acknowledged","in_progress","done","dismissed"]}},"required":["id","status"],"additionalProperties":false}}},"required":["action","historyEntryId","group"],"additionalProperties":false},"AlphaAdvisorActionsUpdateV2Request":{"type":"object","properties":{"actionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"state":{"description":"acknowledged is Open; done is Completed","type":"string","enum":["acknowledged","in_progress","done","dismissed"]},"dismissalReason":{"description":"Why, for a dismissal (optional): kept while it stays dismissed; dismissing it again without one keeps the reason already given","type":"string","minLength":1,"maxLength":4000},"note":{"type":"string","minLength":1,"maxLength":4000},"content":{"description":"The action's whole content, written as its next revision","type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":300,"description":"What to do, in a few words"},"body":{"type":"string","minLength":1,"maxLength":8000,"description":"Why: the evidence-backed rationale"},"action":{"type":"string","maxLength":4000,"description":"What to do, in detail; may be empty"},"area":{"type":"string","enum":["product","content","distribution","pricing_packaging","compliance_security","sales_enablement","competitive_positioning","customer_success","operations"]},"effort":{"type":"string","enum":["low","medium","high"]},"subject":{"$ref":"#/components/schemas/AlphaSubject"},"expectedEffect":{"description":"What it is expected to move, on a metric an evidence product declares","anyOf":[{"type":"object","properties":{"product":{"type":"string","enum":["discovery","experience","inspector"]},"metric":{"type":"string","maxLength":100,"pattern":"^[a-z][a-z0-9]*(?:_[a-z0-9]+)*$"},"unit":{"type":"string","enum":["pp","count","ratio","usd"]},"horizon":{"type":"string","maxLength":200},"estimate":{"anyOf":[{"type":"number"},{"type":"null"}]},"low":{"anyOf":[{"type":"number"},{"type":"null"}]},"high":{"anyOf":[{"type":"number"},{"type":"null"}]},"assumptions":{"type":"string","maxLength":2000},"revenueLineIds":{"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":200}}},"required":["product","metric","unit","horizon","estimate","low","high","assumptions"],"additionalProperties":false},{"type":"null"}]},"completionCriteria":{"description":"How to tell it is done; autotracking writes its own when none are given","anyOf":[{"maxItems":20,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$","description":"A short stable key, e.g. walk_in_hours_clinic_a"},"requirement":{"type":"string","minLength":1,"maxLength":400,"description":"What must be visible on the public site, in one sentence"},"scope":{"type":"string","minLength":1,"maxLength":300,"description":"Where it must be visible: which pages, locations, or plans"}},"required":["id","requirement","scope"]}},{"type":"null"}]}},"required":["title","body","action","area","effort"],"additionalProperties":false},"expectedRevision":{"description":"With content: the actionRevision it was edited from; a change since refuses as STALE_WRITE","type":"integer","minimum":0,"maximum":9007199254740991}},"required":["actionId"],"additionalProperties":false},"AlphaAdvisorActionsUpdateV2Response":{"type":"object","properties":{"action":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"section":{"anyOf":[{"type":"string","enum":["awaiting_review","listed","set_aside"]},{"type":"null"}],"description":"awaiting_review: open and not yet ordered by the published review (new or changed since it read the list), or any action before the first review; listed: on its order, or, with no position, done or dismissed and not placed by it; set_aside: set aside by an older review, until a review places it again. Null when the action is off the list (retired or merged by an older review, or every live evidence link's campaign has left)"},"position":{"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"null"}],"description":"Its place in the published review's order; null while awaiting review, once done or dismissed and not placed by it, or off the list"},"why":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The published review's one sentence why it is placed so"},"reviewId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The published review that placed it"},"state":{"type":"string","enum":["acknowledged","in_progress","done","dismissed"],"description":"acknowledged is Open; done is Completed"},"status":{"type":"string","enum":["open","completed","dismissed"]},"statusControl":{"type":"string","enum":["automatic","manual"],"description":"automatic: a review may revise or dismiss it; manual: a person or API key set it, and a review never revises or dismisses it. A review may complete, reopen or resurface either"},"disposition":{"type":"string","enum":["active","set_aside","retired","merged"]},"mergedIntoId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The action an older review merged it into"},"actionRevision":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Advances with every change; update.v2's expectedRevision names it"},"revision":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ordinal":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["id","ordinal"],"additionalProperties":false,"description":"Its current content revision"},"content":{"$ref":"#/components/schemas/AlphaContent"},"valueUsd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The opportunity its expected effect stands for a year on the revenue lines it names, where Advisor priced it: on a campaign, a share of those lines' AI-influenced market, not the company's revenue, so it can exceed the brand's own sales; on a site Inspector measures, the brand's own sales on those lines that its mobile speed moves"},"valueUnpriced":{"anyOf":[{"type":"string","enum":["no_expected_effect","no_estimate","not_an_increase","unit_unpriced","metric_unpriced","no_campaign","not_measured","no_revenue_economics"]},{"type":"null"}],"description":"Why it has no dollar value, where a review said: no_expected_effect, no_estimate, not_an_increase, unit_unpriced, metric_unpriced (no owner prices its metric), no_campaign, not_measured (nothing measured on its campaign yet to price it), or no_revenue_economics (its campaign's revenue lines have no Revenue Tracking economics); null when priced or unsaid, and when its effect names none of its campaign's priced revenue lines (its revision's valueBasis.unpriced says no_revenue_line)"},"findings":{"$ref":"#/components/schemas/AlphaFindings"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"createdByKind":{"anyOf":[{"type":"string","enum":["person","api_key","automation","review","unknown"]},{"type":"null"}]},"firstSuggestedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"lastStateChangeAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"dismissedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"dismissalReason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Why it was dismissed; null when dismissed without a reason, or not dismissed"},"latestStateChange":{"$ref":"#/components/schemas/AlphaLatestStateChange"},"implementation":{"$ref":"#/components/schemas/AlphaImplementation2"},"latestOutcome":{"$ref":"#/components/schemas/AlphaLatestOutcome"},"conversation":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The action's Ship with Alpha conversation"},"failed":{"type":"boolean","description":"Its latest turn failed (a stop is not a failure)"}},"required":["id","failed"],"additionalProperties":false},{"type":"null"}]}},"required":["id","section","position","why","reviewId","state","status","statusControl","disposition","mergedIntoId","actionRevision","revision","content","valueUsd","valueUnpriced","findings","createdAt","createdByKind","firstSuggestedAt","lastStateChangeAt","dismissedAt","dismissalReason","latestStateChange","implementation","latestOutcome","conversation"],"additionalProperties":false,"description":"The action as it now stands"},"eventIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":"Every event recorded, in order: the status change, a note it could not carry, and the change of control when a person or key took the action from automation; empty when it changed nothing"},"revisionId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The content revision written; null without content"}},"required":["action","eventIds","revisionId"],"additionalProperties":false},"AlphaAdvisorActionStatusesUpdateRequest":{"type":"object","properties":{"actionIds":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":"The actions to change, up to 100"},"status":{"type":"string","enum":["open","completed","dismissed"],"description":"open: work still to do; completed: done; dismissed: won't do"},"dismissalReason":{"description":"Why, for a dismissal (optional there, refused elsewhere): kept on each action; one already dismissed keeps its reason when none is given","type":"string","minLength":1,"maxLength":4000}},"required":["actionIds","status"],"additionalProperties":false},"AlphaAdvisorActionStatusesUpdateResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"status":{"type":"string","enum":["open","completed","dismissed"]},"state":{"type":"string","enum":["acknowledged","in_progress","done","dismissed"],"description":"acknowledged and in_progress are Open; done is Completed"},"changed":{"type":"boolean","description":"False when it already had the status and was already the caller's (manual)"},"eventIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":"Every event recorded, in order: the status change and the change of control when the caller took it from automation; empty when it changed nothing"}},"required":["id","status","state","changed","eventIds"],"additionalProperties":false},"description":"Each action named, in the order named"},"changedCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"How many actions changed (changed true)"}},"required":["data","changedCount"],"additionalProperties":false},"AlphaAdvisorActionSelectionsListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"status":{"type":"string","enum":["open","completed","dismissed"]}},"required":["id","status"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"AlphaAdvisorActionsRestoreAutomationRequest":{"type":"object","properties":{"actionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["actionId"],"additionalProperties":false},"AlphaAdvisorActionsRestoreAutomationResponse":{"type":"object","properties":{"action":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"statusControl":{"type":"string","enum":["automatic","manual"]}},"required":["id","statusControl"],"additionalProperties":false},"historyEntryId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["action","historyEntryId"],"additionalProperties":false},"AlphaAdvisorActionsStartConversationRequest":{"type":"object","properties":{"actionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["actionId"],"additionalProperties":false},"AlphaAdvisorActionsStartConversationResponse":{"type":"object","properties":{"conversationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"created":{"type":"boolean"}},"required":["conversationId","created"],"additionalProperties":false},"AlphaAdvisorActivitiesGetResponse":{"type":"object","properties":{"product":{"type":"string","enum":["studio","advisor","alpha","inspector"]},"reading":{"$ref":"#/components/schemas/InspectorReading"},"subject":{"anyOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["creative_project","conversation","scan"]},"id":{"type":"string","minLength":1},"name":{"type":"string"}},"required":["kind","id","name"],"additionalProperties":false},{"type":"null"}]},"observedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"lastUpdate":{"description":"Present only when asked: what the published review changed, null before the first","anyOf":[{"type":"object","properties":{"reviewId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The published review"},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"changes":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["added","updated","resurfaced","completed","reopened","dropped"]},"actionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"title":{"type":"string","description":"The action's current title"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Why: the review's why for an added or updated action, the move's reason for a status change"}},"required":["kind","actionId","title","reason"],"additionalProperties":false},"description":"In the order the review made them"}},"required":["reviewId","publishedAt","changes"],"additionalProperties":false},{"type":"null"}]}},"required":["product","reading","subject","observedAt"],"additionalProperties":false},"AlphaAdvisorReviewsListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The review's run; platform.runs.get reads it"},"origin":{"anyOf":[{"type":"string","enum":["schedule","launch","run_now","recovery"]},{"type":"null"}],"description":"Why it ran: its schedule, a Bootup's launch, a person's Run Advisor or saved priorities, or its own recovery; null for a review run before origins were kept"},"retryOf":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The failed review it ran again"},"state":{"type":"string","enum":["running","published","failed","stale"],"description":"running; published (the list's order is its); failed; stale (the list changed while it ran, so it published nothing and another review is owed)"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"completedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}],"description":"When it settled; null while it runs"},"failureCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"settingsRevision":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"baseListRevision":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]}},"required":["id","origin","retryOf","state","createdAt","completedAt","failureCode","settingsRevision","baseListRevision"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"AlphaAdvisorReviewsGetResponse":{"type":"object","properties":{"id":{"type":"string","const":"organization","description":"\"organization\", Advisor's one org-wide review"},"review":{"anyOf":[{"type":"object","properties":{"runId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The review's run; platform.runs.get reads it"},"state":{"type":"string","enum":["running","published","failed"]},"completedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}],"description":"When it published or failed; null while it runs"},"canRetry":{"type":"boolean","description":"It failed, so alpha.advisor-reviews.run.v1 runs it again"}},"required":["runId","state","completedAt","canRetry"],"additionalProperties":false},{"type":"null"}],"description":"Null before the organization's first review"}},"required":["id","review"],"additionalProperties":false},"AlphaAdvisorReviewsGetV2Response":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"string","enum":["latest","published"]}],"description":"The id asked for, as asked"},"review":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The review's run; platform.runs.get reads it"},"origin":{"anyOf":[{"type":"string","enum":["schedule","launch","run_now","recovery"]},{"type":"null"}],"description":"Why it ran: its schedule, a Bootup's launch, a person's Run Advisor or saved priorities, or its own recovery; null for a review run before origins were kept"},"retryOf":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The failed review it ran again"},"state":{"type":"string","enum":["running","published","failed","stale"],"description":"running; published (the list's order is its); failed; stale (the list changed while it ran, so it published nothing and another review is owed)"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"completedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}],"description":"When it settled; null while it runs"},"failureCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"settingsRevision":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"baseListRevision":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"canRetry":{"type":"boolean","description":"It is the newest and failed, so alpha.advisor-reviews.run.v1 runs it again"},"manifest":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"product":{"type":"string","enum":["discovery","experience","inspector"]},"subjectId":{"type":"string","description":"The campaign's id, or the site a product without campaigns scanned"},"subjectName":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The campaign's name as it stands now; null for a subject that is no campaign (a scanned site), or a campaign since deleted or unnamed"},"publicationId":{"type":"string"},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["product","subjectId","subjectName","publicationId","publishedAt"],"additionalProperties":false}},{"type":"null"}],"description":"Each subject's newest publication when the review was admitted: what it read; null for a review admitted before reviews froze one"}},"required":["id","origin","retryOf","state","createdAt","completedAt","failureCode","settingsRevision","baseListRevision","canRetry","manifest"],"additionalProperties":false},{"type":"null"}],"description":"Null for \"latest\" before the organization's first review, and for \"published\" before its first published list"}},"required":["id","review"],"additionalProperties":false},"AlphaAdvisorReviewsRunRequest":{"type":"object","properties":{},"additionalProperties":false},"AlphaAdvisorReviewsRunResponse":{"type":"object","properties":{"state":{"type":"string","enum":["admitted","owed","refused"],"description":"admitted: a review started. owed: one is running, and one more runs right after it. refused: it could not start now"},"runId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The review admitted, or the one running when owed; null when refused (or when the running one could not be read)"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Why it could not start, when refused (Billing's admission refusal)"},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The sentence Billing words a refusal in, with the one action that changes it; null unless refused for the account's billing standing"}},"required":["state","runId","reason","message"],"additionalProperties":false},"AlphaAdvisorReviewsRetryRequest":{"type":"object","properties":{"id":{"type":"string","const":"organization","description":"\"organization\", Advisor's one org-wide review"}},"required":["id"],"additionalProperties":false,"deprecated":true},"AlphaAdvisorReviewsRetryResponse":{"type":"object","properties":{"id":{"type":"string","const":"organization","description":"\"organization\", Advisor's one org-wide review"},"state":{"type":"string","enum":["admitted","running","current","nothing_to_review","waiting","refused"],"description":"admitted: a new review started. running: one is already running. current: the newest review published. waiting: the newest found the list changed while it ran, and the review it owes runs shortly. nothing_to_review: no review has run yet. refused: it could not start now"},"runId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The review run admitted, running or current; null otherwise"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Why it could not start, when refused (Billing's admission refusal); null otherwise"}},"required":["id","state","runId","reason"],"additionalProperties":false},"AlphaAdvisorSettingsGetV2Response":{"type":"object","properties":{"id":{"type":"string","const":"organization","description":"\"organization\", Advisor's one org-wide scope"},"settings":{"type":"object","properties":{"refreshInterval":{"type":"string","enum":["weekly","monthly"]},"steering":{"anyOf":[{"type":"string"},{"type":"null"}]},"implementationTrackingEnabled":{"type":"boolean"}},"required":["refreshInterval","steering","implementationTrackingEnabled"],"additionalProperties":false},"sources":{"type":"object","properties":{"refreshInterval":{"type":"string","enum":["organization","product"]},"steering":{"type":"string","enum":["organization","product"]},"implementationTrackingEnabled":{"type":"string","enum":["organization","product"]}},"required":["refreshInterval","steering","implementationTrackingEnabled"],"additionalProperties":false},"stored":{"type":"object","properties":{"refreshInterval":{"type":"string","enum":["weekly","monthly"]},"steering":{"anyOf":[{"type":"string"},{"type":"null"}]},"implementationTrackingEnabled":{"type":"boolean"}},"additionalProperties":false}},"required":["id","settings","sources","stored"],"additionalProperties":false},"AlphaAdvisorSettingsGetV3Response":{"type":"object","properties":{"id":{"type":"string","const":"organization","description":"\"organization\", Advisor's one org-wide scope"},"settings":{"type":"object","properties":{"refreshInterval":{"type":"string","enum":["weekly","monthly"]},"priorities":{"anyOf":[{"type":"string"},{"type":"null"}]},"implementationTrackingEnabled":{"type":"boolean"}},"required":["refreshInterval","priorities","implementationTrackingEnabled"],"additionalProperties":false},"sources":{"type":"object","properties":{"refreshInterval":{"type":"string","enum":["organization","product"]},"priorities":{"type":"string","enum":["organization","product"]},"implementationTrackingEnabled":{"type":"string","enum":["organization","product"]}},"required":["refreshInterval","priorities","implementationTrackingEnabled"],"additionalProperties":false},"stored":{"type":"object","properties":{"refreshInterval":{"type":"string","enum":["weekly","monthly"]},"priorities":{"anyOf":[{"type":"string"},{"type":"null"}]},"implementationTrackingEnabled":{"type":"boolean"}},"additionalProperties":false}},"required":["id","settings","sources","stored"],"additionalProperties":false},"AlphaAdvisorSettingsGetV4Response":{"type":"object","properties":{"id":{"type":"string","const":"organization","description":"\"organization\", Advisor's one org-wide scope"},"refreshInterval":{"type":"string","enum":["weekly","monthly"],"description":"When Advisor reviews the list: each UTC month from the 1st, or each UTC week from Monday"},"priorities":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What Advisor weighs, and leaves out what conflicts with; null is none"},"implementationTracking":{"type":"string","enum":["off","suggest","complete"],"description":"Autotracking as recorded: off, suggest or complete. Nothing acts on it any more: Advisor's review checks the site itself"},"listSize":{"type":"number","enum":[3,5,10,15,20],"description":"The most open actions each Advisor review keeps on the list, the largest opportunities first"},"revision":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The current revision; 0 before the first save, when the product defaults run"},"savedBy":{"anyOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["person","api_key","unknown"],"description":"A member (person), an API key (api_key), or unknown for settings carried from before Advisor recorded who saved them"},"id":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The member's user id or the API key's id; null when unknown"},"name":{"description":"The member's name (else their email) or the key's name, while it exists","type":"string"}},"required":["kind","id"],"additionalProperties":false},{"type":"null"}],"description":"Who saved the current revision; null before any"},"savedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}],"description":"When the current revision was saved; null before any"},"history":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"refreshInterval":{"type":"string","enum":["weekly","monthly"],"description":"When Advisor reviews the list: each UTC month from the 1st, or each UTC week from Monday"},"priorities":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What Advisor weighs, and leaves out what conflicts with; null is none"},"listSize":{"type":"number","enum":[3,5,10,15,20],"description":"The most open actions each Advisor review keeps on the list, the largest opportunities first"},"revision":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"The revision's number: each save adds one"},"savedBy":{"type":"object","properties":{"kind":{"type":"string","enum":["person","api_key","unknown"],"description":"A member (person), an API key (api_key), or unknown for settings carried from before Advisor recorded who saved them"},"id":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The member's user id or the API key's id; null when unknown"},"name":{"description":"The member's name (else their email) or the key's name, while it exists","type":"string"}},"required":["kind","id"],"additionalProperties":false,"description":"Who saved it"},"savedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"When it was saved"},"implementationTracking":{"type":"string","enum":["off","suggest","complete"],"description":"Autotracking as recorded: off, suggest or complete. Nothing acts on it any more: Advisor's review checks the site itself"}},"required":["refreshInterval","priorities","listSize","revision","savedBy","savedAt","implementationTracking"],"additionalProperties":false},"description":"The newest 50 revisions, newest first (the first is the current one); empty before the first save"}},"required":["id","refreshInterval","priorities","implementationTracking","listSize","revision","savedBy","savedAt","history"],"additionalProperties":false},"AlphaAdvisorSettingsGetV5Response":{"type":"object","properties":{"id":{"type":"string","const":"organization","description":"\"organization\", Advisor's one org-wide scope"},"refreshInterval":{"type":"string","enum":["weekly","monthly"],"description":"When Advisor reviews the list: each UTC month from the 1st, or each UTC week from Monday"},"priorities":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What Advisor weighs, and leaves out what conflicts with; null is none"},"listSize":{"type":"number","enum":[3,5,10,15,20],"description":"The most open actions each Advisor review keeps on the list, the largest opportunities first"},"revision":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The current revision; 0 before the first save, when the product defaults run"},"savedBy":{"anyOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["person","api_key","unknown"],"description":"A member (person), an API key (api_key), or unknown for settings carried from before Advisor recorded who saved them"},"id":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The member's user id or the API key's id; null when unknown"},"name":{"description":"The member's name (else their email) or the key's name, while it exists","type":"string"}},"required":["kind","id"],"additionalProperties":false},{"type":"null"}],"description":"Who saved the current revision; null before any"},"savedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}],"description":"When the current revision was saved; null before any"},"history":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"refreshInterval":{"type":"string","enum":["weekly","monthly"],"description":"When Advisor reviews the list: each UTC month from the 1st, or each UTC week from Monday"},"priorities":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What Advisor weighs, and leaves out what conflicts with; null is none"},"listSize":{"type":"number","enum":[3,5,10,15,20],"description":"The most open actions each Advisor review keeps on the list, the largest opportunities first"},"revision":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"The revision's number: each save adds one"},"savedBy":{"type":"object","properties":{"kind":{"type":"string","enum":["person","api_key","unknown"],"description":"A member (person), an API key (api_key), or unknown for settings carried from before Advisor recorded who saved them"},"id":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The member's user id or the API key's id; null when unknown"},"name":{"description":"The member's name (else their email) or the key's name, while it exists","type":"string"}},"required":["kind","id"],"additionalProperties":false,"description":"Who saved it"},"savedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"When it was saved"}},"required":["refreshInterval","priorities","listSize","revision","savedBy","savedAt"],"additionalProperties":false},"description":"The newest 50 revisions, newest first (the first is the current one); empty before the first save"}},"required":["id","refreshInterval","priorities","listSize","revision","savedBy","savedAt","history"],"additionalProperties":false},"AlphaAdvisorSettingsUpdateV2Request":{"type":"object","properties":{"id":{"type":"string","const":"organization","description":"\"organization\", Advisor's one org-wide scope"},"settings":{"type":"object","properties":{"refreshInterval":{"type":"string","enum":["weekly","monthly"]},"steering":{"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}]},"implementationTrackingEnabled":{"type":"boolean"}},"additionalProperties":false}},"required":["id","settings"],"additionalProperties":false,"deprecated":true},"AlphaAdvisorSettingsUpdateV2Response":{"type":"object","properties":{"id":{"type":"string","const":"organization","description":"\"organization\", Advisor's one org-wide scope"},"settings":{"type":"object","properties":{"refreshInterval":{"type":"string","enum":["weekly","monthly"]},"steering":{"anyOf":[{"type":"string"},{"type":"null"}]},"implementationTrackingEnabled":{"type":"boolean"}},"required":["refreshInterval","steering","implementationTrackingEnabled"],"additionalProperties":false},"sources":{"type":"object","properties":{"refreshInterval":{"type":"string","enum":["organization","product"]},"steering":{"type":"string","enum":["organization","product"]},"implementationTrackingEnabled":{"type":"string","enum":["organization","product"]}},"required":["refreshInterval","steering","implementationTrackingEnabled"],"additionalProperties":false},"stored":{"type":"object","properties":{"refreshInterval":{"type":"string","enum":["weekly","monthly"]},"steering":{"anyOf":[{"type":"string"},{"type":"null"}]},"implementationTrackingEnabled":{"type":"boolean"}},"additionalProperties":false}},"required":["id","settings","sources","stored"],"additionalProperties":false},"AlphaAdvisorSettingsUpdateV3Request":{"type":"object","properties":{"id":{"type":"string","const":"organization","description":"\"organization\", Advisor's one org-wide scope"},"settings":{"type":"object","properties":{"refreshInterval":{"type":"string","enum":["weekly","monthly"]},"priorities":{"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}]},"implementationTrackingEnabled":{"type":"boolean"}},"additionalProperties":false}},"required":["id","settings"],"additionalProperties":false,"deprecated":true},"AlphaAdvisorSettingsUpdateV3Response":{"type":"object","properties":{"id":{"type":"string","const":"organization","description":"\"organization\", Advisor's one org-wide scope"},"settings":{"type":"object","properties":{"refreshInterval":{"type":"string","enum":["weekly","monthly"]},"priorities":{"anyOf":[{"type":"string"},{"type":"null"}]},"implementationTrackingEnabled":{"type":"boolean"}},"required":["refreshInterval","priorities","implementationTrackingEnabled"],"additionalProperties":false},"sources":{"type":"object","properties":{"refreshInterval":{"type":"string","enum":["organization","product"]},"priorities":{"type":"string","enum":["organization","product"]},"implementationTrackingEnabled":{"type":"string","enum":["organization","product"]}},"required":["refreshInterval","priorities","implementationTrackingEnabled"],"additionalProperties":false},"stored":{"type":"object","properties":{"refreshInterval":{"type":"string","enum":["weekly","monthly"]},"priorities":{"anyOf":[{"type":"string"},{"type":"null"}]},"implementationTrackingEnabled":{"type":"boolean"}},"additionalProperties":false}},"required":["id","settings","sources","stored"],"additionalProperties":false},"AlphaAdvisorSettingsUpdateV4Request":{"type":"object","properties":{"id":{"type":"string","const":"organization","description":"\"organization\", Advisor's one org-wide scope"},"refreshInterval":{"type":"string","enum":["weekly","monthly"],"description":"When Advisor reviews the list: each UTC month from the 1st, or each UTC week from Monday"},"priorities":{"description":"What Advisor weighs, and leaves out what conflicts with; null or empty is none","anyOf":[{"type":"string","maxLength":2000},{"type":"null"}]},"listSize":{"type":"number","enum":[3,5,10,15,20],"description":"The most open actions each Advisor review keeps on the list, the largest opportunities first"},"implementationTracking":{"type":"string","enum":["off","suggest","complete"],"description":"Autotracking as recorded: off, suggest or complete. Nothing acts on it any more: Advisor's review checks the site itself"}},"required":["id"],"additionalProperties":false,"deprecated":true},"AlphaAdvisorSettingsUpdateV4Response":{"type":"object","properties":{"id":{"type":"string","const":"organization","description":"\"organization\", Advisor's one org-wide scope"},"refreshInterval":{"type":"string","enum":["weekly","monthly"],"description":"When Advisor reviews the list: each UTC month from the 1st, or each UTC week from Monday"},"priorities":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What Advisor weighs, and leaves out what conflicts with; null is none"},"listSize":{"type":"number","enum":[3,5,10,15,20],"description":"The most open actions each Advisor review keeps on the list, the largest opportunities first"},"revision":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"The revision's number: each save adds one"},"savedBy":{"type":"object","properties":{"kind":{"type":"string","enum":["person","api_key","unknown"],"description":"A member (person), an API key (api_key), or unknown for settings carried from before Advisor recorded who saved them"},"id":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The member's user id or the API key's id; null when unknown"},"name":{"description":"The member's name (else their email) or the key's name, while it exists","type":"string"}},"required":["kind","id"],"additionalProperties":false,"description":"Who saved it"},"savedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"When it was saved"},"implementationTracking":{"type":"string","enum":["off","suggest","complete"],"description":"Autotracking as recorded: off, suggest or complete. Nothing acts on it any more: Advisor's review checks the site itself"}},"required":["id","refreshInterval","priorities","listSize","revision","savedBy","savedAt","implementationTracking"],"additionalProperties":false},"AlphaAdvisorSettingsUpdateV5Request":{"type":"object","properties":{"id":{"type":"string","const":"organization","description":"\"organization\", Advisor's one org-wide scope"},"refreshInterval":{"type":"string","enum":["weekly","monthly"],"description":"When Advisor reviews the list: each UTC month from the 1st, or each UTC week from Monday"},"priorities":{"description":"What Advisor weighs, and leaves out what conflicts with; null or empty is none","anyOf":[{"type":"string","maxLength":2000},{"type":"null"}]},"listSize":{"type":"number","enum":[3,5,10,15,20],"description":"The most open actions each Advisor review keeps on the list, the largest opportunities first"}},"required":["id"],"additionalProperties":false},"AlphaAdvisorSettingsUpdateV5Response":{"type":"object","properties":{"id":{"type":"string","const":"organization","description":"\"organization\", Advisor's one org-wide scope"},"refreshInterval":{"type":"string","enum":["weekly","monthly"],"description":"When Advisor reviews the list: each UTC month from the 1st, or each UTC week from Monday"},"priorities":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What Advisor weighs, and leaves out what conflicts with; null is none"},"listSize":{"type":"number","enum":[3,5,10,15,20],"description":"The most open actions each Advisor review keeps on the list, the largest opportunities first"},"revision":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"The revision's number: each save adds one"},"savedBy":{"type":"object","properties":{"kind":{"type":"string","enum":["person","api_key","unknown"],"description":"A member (person), an API key (api_key), or unknown for settings carried from before Advisor recorded who saved them"},"id":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The member's user id or the API key's id; null when unknown"},"name":{"description":"The member's name (else their email) or the key's name, while it exists","type":"string"}},"required":["kind","id"],"additionalProperties":false,"description":"Who saved it"},"savedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"When it was saved"}},"required":["id","refreshInterval","priorities","listSize","revision","savedBy","savedAt"],"additionalProperties":false},"AlphaWinCustomerProjectsListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"conversationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customerName":{"type":"string"},"title":{"type":"string"},"planned":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"totalSteps":{"type":"integer","minimum":0,"maximum":9007199254740991},"completedSteps":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["requestId","conversationId","customerName","title","planned","createdAt","totalSteps","completedSteps"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"AlphaWinCustomerProjectsGetResponse":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customerName":{"type":"string"},"scope":{"type":"object","properties":{"trigger":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"customer"},"customerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customerVersionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","customerId"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"experience"},"runId":{"type":"string","minLength":1}},"required":["kind","runId"],"additionalProperties":false}]},"customerId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"customerVersionId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"customerName":{"type":"string","minLength":1},"businessProfileId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"businessName":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"asOf":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"sources":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"product":{"type":"string","enum":["business","discovery","experience"]},"kind":{"type":"string","enum":["profile","conversation","citation","journey","evaluation","metric"]},"title":{"type":"string","minLength":1},"href":{"type":"string","pattern":"^\\/.*"},"runId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"campaignId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"occurredAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]}},"required":["id","product","kind","title","href","runId","campaignId","occurredAt"],"additionalProperties":false}},"coverage":{"type":"array","items":{"type":"object","properties":{"product":{"type":"string","enum":["discovery","experience"]},"state":{"type":"string","enum":["available","partial","unavailable"]},"message":{"type":"string","minLength":1}},"required":["product","state","message"],"additionalProperties":false}}},"required":["trigger","customerId","customerVersionId","customerName","businessProfileId","businessName","asOf","sources","coverage"],"additionalProperties":false},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"conversationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["requestId","customerName","scope","createdAt","conversationId"],"additionalProperties":false},"AlphaWinCustomerProjectsCreateRequest":{"type":"object","properties":{"trigger":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"customer"},"customerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customerVersionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","customerId"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"experience"},"runId":{"type":"string","minLength":1}},"required":["kind","runId"],"additionalProperties":false}]}},"required":["trigger"],"additionalProperties":false},"AlphaWinCustomerProjectsCreateResponse":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"conversationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["requestId","conversationId"],"additionalProperties":false},"AlphaCustomerCasesCreateRequest":{"type":"object","properties":{"kind":{"type":"string","enum":["customer_edit","customer_describe","crm_import"],"description":"customer_edit for Bulk edit's selected customers, customer_describe for the new customers Describe adds, crm_import for a CRM upload's column mapping"},"businessProfileId":{"description":"customer_describe and crm_import only: the business profile the new customers, or the upload's rows, are added to","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customerIds":{"description":"customer_edit only: the selected customers' ids, of any of the organization's business profiles, in the grid's order, each once","minItems":1,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"count":{"description":"customer_describe only: how many new customers the case describes","type":"integer","minimum":1,"maximum":5000},"name":{"description":"crm_import only: the upload's name","type":"string","minLength":1,"maxLength":120},"rowCount":{"description":"crm_import only: how many rows the upload's file holds","type":"integer","minimum":1,"maximum":20000},"mappingVersionId":{"description":"crm_import only: the saved CSV mapping version the case opens on (business_crm_mapping_versions_create_v2's version.id)","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind"],"additionalProperties":false},"AlphaCustomerCasesCreateResponse":{"type":"object","properties":{"caseId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"conversationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["caseId","conversationId"],"additionalProperties":false},"AlphaCustomerCasesGetResponse":{"type":"object","properties":{"caseId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"conversationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The case's Alpha conversation"},"kind":{"type":"string","enum":["customer_edit","customer_describe","crm_import"]},"businessProfileId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The business profile a describe case adds customers to, or a CRM import's upload adds to; null for a customer edit, whose selection may span profiles"},"customerCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"How many customers a customer edit's selection holds now (a deleted customer leaves it); 0 for any other kind"},"count":{"anyOf":[{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},{"type":"null"}],"description":"How many rows the case's grid makes: the new customers a describe case describes, or the rows a CRM import's file holds; null for a customer edit"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A CRM import's name, its upload's; null on any other kind"},"latestReviewRunIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":"Every review the case's most recent reviewing turn requested (one per group of the selection it changes differently), in request order, each the run business_customer_edit_reviews_get_v2 follows; empty before the first"},"latestReviewTurnId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The turn those reviews belong to, as a review's live part names it; null before the first review"},"latestDescriptionId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The newest description a describe case's turns requested, which business_customer_descriptions_get reads; null before the first"},"latestMappingVersionId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The mapping version a CRM import follows now (its Lead's latest, or the member's own from the grid), which business_crm_mapping_versions_get reads and the upload imports under; null on any other kind"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["caseId","conversationId","kind","businessProfileId","customerCount","count","name","latestReviewRunIds","latestReviewTurnId","latestDescriptionId","latestMappingVersionId","createdAt"],"additionalProperties":false},"AlphaCustomerCasesUpdateRequest":{"type":"object","properties":{"caseId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The case's caseId"},"count":{"description":"A describe case's: how many new customers it describes now","type":"integer","minimum":1,"maximum":5000},"mappingVersionId":{"description":"A CRM import's: the mapping version the member saved from the grid (business_crm_mapping_versions_create_v2's version.id), of the case's own upload","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["caseId"],"additionalProperties":false},"AlphaCustomerCasesUpdateResponse":{"type":"object","properties":{"caseId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"count":{"anyOf":[{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},{"type":"null"}],"description":"A describe case's count now; null on a CRM import"},"latestMappingVersionId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The mapping version a CRM import follows now; null on a describe case"}},"required":["caseId","count","latestMappingVersionId"],"additionalProperties":false},"AlphaActivitiesGetResponse":{"type":"object","properties":{"product":{"type":"string","enum":["studio","advisor","alpha","inspector"]},"reading":{"$ref":"#/components/schemas/InspectorReading"},"subject":{"anyOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["creative_project","conversation","scan"]},"id":{"type":"string","minLength":1},"name":{"type":"string"}},"required":["kind","id","name"],"additionalProperties":false},{"type":"null"}]},"observedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["product","reading","subject","observedAt"],"additionalProperties":false},"AlphaConversationsListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"title":{"type":"string"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["id","title","createdAt","updatedAt"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"AlphaProjectsListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"conversationCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"visibility":{"type":"string","enum":["private","organization"]},"mine":{"type":"boolean"},"ownerName":{"type":"string"}},"required":["id","name","conversationCount","updatedAt","visibility","mine","ownerName"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"currentProjectId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["data","nextCursor","currentProjectId"],"additionalProperties":false},"AlphaProjectsGetResponse":{"type":"object","properties":{"project":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"conversationCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"visibility":{"type":"string","enum":["private","organization"]},"mine":{"type":"boolean"},"ownerName":{"type":"string"}},"required":["id","name","conversationCount","updatedAt","visibility","mine","ownerName"],"additionalProperties":false},"instructions":{"anyOf":[{"type":"string"},{"type":"null"}]},"pins":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"title":{"type":"string"},"kind":{"type":"string","enum":["markdown","slides","image","audio","video","brand_kit","presentation","spreadsheet","word","pdf","csv","page"]},"conversationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"pinnedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["artifactId","title","kind","conversationId","pinnedAt"],"additionalProperties":false}},"conversations":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"title":{"type":"string"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"mine":{"type":"boolean"},"ownerName":{"type":"string"}},"required":["id","title","createdAt","updatedAt","mine","ownerName"],"additionalProperties":false}},"hasOlderConversations":{"type":"boolean"}},"required":["project","instructions","pins","conversations","hasOlderConversations"],"additionalProperties":false},"AlphaFilesListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"title":{"type":"string"},"kind":{"type":"string","enum":["markdown","slides","image","audio","video","brand_kit","presentation","spreadsheet","word","pdf","csv","page"]},"mediaType":{"type":"string","enum":["text/markdown","application/vnd.point11.slides+json","image/png","image/jpeg","image/webp","audio/mpeg","audio/wav","video/mp4","video/webm","application/vnd.point11.brand-kit+json","application/vnd.openxmlformats-officedocument.presentationml.presentation","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","application/vnd.openxmlformats-officedocument.wordprocessingml.document","application/pdf","text/csv","text/html","application/vnd.point11.website+json"]},"conversationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"conversationTitle":{"type":"string"},"mine":{"type":"boolean","description":"The conversation is the reader's own; false for a teammate's conversation in a shared project"},"thumbnailArtifactId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"A stored image that stands for the file (an image itself, or a website's thumbnail), read with alpha.artifacts.download; null for every other kind"},"purpose":{"type":"string","enum":["deliverable","working"],"description":"What the file is for: deliverable, what the person asked for; working, a file a turn made on the way (a CSV handed to a build, a scratch check), listed only with includeWorking"},"committedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"A five-minute presigned read of the file's bytes; null when none could be issued, and for a signed-in dashboard session, which reads them through alpha.artifacts.download"},"urlExpiresAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}],"description":"When `url` stops working"}},"required":["artifactId","title","kind","mediaType","conversationId","conversationTitle","mine","thumbnailArtifactId","purpose","committedAt","url","urlExpiresAt"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"AlphaConnectorsListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"uid":{"type":"string","minLength":1,"description":"The connector's stable product id"},"service":{"type":"string"},"label":{"type":"string"},"status":{"type":"string","enum":["connected","not_connected","setup_required","environment_disabled","unavailable","coming_soon"]},"account":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The provider-side account the connection reports, when connected"}},"required":["uid","service","label","status","account"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"AlphaConnectorFilesListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"ref":{"type":"string","minLength":1,"maxLength":1024},"name":{"type":"string"},"kind":{"type":"string","enum":["file","folder"]},"mediaType":{"anyOf":[{"type":"string"},{"type":"null"}]},"byteLength":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"detail":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["ref","name","kind","mediaType","byteLength","modifiedAt","detail"],"additionalProperties":false}},"container":{"anyOf":[{"type":"object","properties":{"ref":{"type":"string","minLength":1,"maxLength":1024},"name":{"type":"string"}},"required":["ref","name"],"additionalProperties":false},{"type":"null"}]},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","container","nextCursor"],"additionalProperties":false},"AlphaConnectorPermissionsGetResponse":{"type":"object","properties":{"connector":{"type":"object","properties":{"uid":{"type":"string","minLength":1,"maxLength":384},"service":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,39}$","description":"The connector's service key, such as linear"},"label":{"type":"string","minLength":1,"maxLength":80}},"required":["uid","service","label"],"additionalProperties":false},"available":{"type":"boolean"},"connection":{"type":"object","properties":{"status":{"type":"string","enum":["connected","not_connected","setup_required","environment_disabled","unavailable","coming_soon"]},"account":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["status","account"],"additionalProperties":false},"actions":{"maxItems":512,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:/-]*$","description":"The action's name as the service lists it, such as create_issue"},"title":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"listed":{"type":"boolean"},"destructive":{"type":"boolean"},"permission":{"oneOf":[{"type":"object","properties":{"state":{"type":"string","const":"off"},"by":{"type":"string","const":"org"}},"required":["state","by"],"additionalProperties":false},{"type":"object","properties":{"state":{"type":"string","const":"blocked"},"by":{"type":"string","const":"org"}},"required":["state","by"],"additionalProperties":false},{"type":"object","properties":{"state":{"type":"string","const":"allowed"},"by":{"type":"string","enum":["org","member"]}},"required":["state","by"],"additionalProperties":false},{"type":"object","properties":{"state":{"type":"string","const":"declined"},"by":{"type":"string","const":"member"}},"required":["state","by"],"additionalProperties":false},{"type":"object","properties":{"state":{"type":"string","const":"ask"},"by":{"type":"string","enum":["org","default"]}},"required":["state","by"],"additionalProperties":false}]},"member":{"anyOf":[{"type":"string","enum":["always_allow","dont_allow"]},{"type":"null"}]},"org":{"anyOf":[{"type":"string","enum":["allow","ask_always","blocked"]},{"type":"null"}]}},"required":["name","title","listed","destructive","permission","member","org"],"additionalProperties":false}},"unsupportedActions":{"maxItems":64,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":128}},"required":["name"],"additionalProperties":false}},"actionsUnavailable":{"anyOf":[{"type":"string","enum":["not_connected","unavailable","viewing_as","coming_soon"]},{"type":"null"}]},"canManage":{"type":"boolean"},"openRequests":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]}},"required":["connector","available","connection","actions","unsupportedActions","actionsUnavailable","canManage","openRequests"],"additionalProperties":false},"AlphaConnectorPermissionsUpdateRequest":{"type":"object","properties":{"service":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,39}$","description":"The connector's service key, such as linear"},"available":{"description":"Switch the connector on or off for everyone","type":"boolean"},"reset":{"description":"Clear every action override first","type":"boolean","const":true},"actions":{"maxItems":256,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:/-]*$","description":"The action's name as the service lists it, such as create_issue"},"decision":{"anyOf":[{"type":"string","enum":["allow","ask_always","blocked"]},{"type":"null"}]}},"required":["name","decision"],"additionalProperties":false}}},"required":["service"],"additionalProperties":false},"AlphaConnectorPermissionsUpdateResponse":{"type":"object","properties":{"service":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,39}$","description":"The connector's service key, such as linear"},"available":{"type":"boolean"},"overrides":{"maxItems":4096,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:/-]*$","description":"The action's name as the service lists it, such as create_issue"},"decision":{"type":"string","enum":["allow","ask_always","blocked"]}},"required":["name","decision"],"additionalProperties":false}}},"required":["service","available","overrides"],"additionalProperties":false},"AlphaConnectorChoicesUpdateRequest":{"type":"object","properties":{"service":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,39}$","description":"The connector's service key, such as linear"},"reset":{"description":"Clear every choice of yours first","type":"boolean","const":true},"actions":{"maxItems":256,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:/-]*$","description":"The action's name as the service lists it, such as create_issue"},"choice":{"anyOf":[{"type":"string","enum":["always_allow","dont_allow"]},{"type":"null"}]}},"required":["name","choice"],"additionalProperties":false}}},"required":["service"],"additionalProperties":false},"AlphaConnectorChoicesUpdateResponse":{"type":"object","properties":{"service":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,39}$","description":"The connector's service key, such as linear"},"choices":{"maxItems":4096,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:/-]*$","description":"The action's name as the service lists it, such as create_issue"},"choice":{"type":"string","enum":["always_allow","dont_allow"]}},"required":["name","choice"],"additionalProperties":false}}},"required":["service","choices"],"additionalProperties":false},"AlphaConnectorApprovalsDecideRequest":{"type":"object","properties":{"turnId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The Alpha turn whose answer carries the card"},"decisions":{"minItems":1,"maxItems":16,"type":"array","items":{"type":"object","properties":{"itemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The card item's id"},"choice":{"type":"string","enum":["always_allow","approve_once","dont_allow","unblock"]}},"required":["itemId","choice"],"additionalProperties":false}}},"required":["turnId","decisions"],"additionalProperties":false},"AlphaConnectorApprovalsDecideResponse":{"type":"object","properties":{"results":{"minItems":1,"maxItems":16,"type":"array","items":{"type":"object","properties":{"itemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"outcome":{"type":"string","enum":["always_allowed","approved_once","declined","unblocked","refused"]},"refusal":{"anyOf":[{"type":"string","enum":["connector_off","blocked","ask_every_time","not_admin","not_offered","dont_allow"]},{"type":"null"}]}},"required":["itemId","outcome","refusal"],"additionalProperties":false}},"question":{"anyOf":[{"type":"string","minLength":1,"maxLength":4000},{"type":"null"}]}},"required":["results","question"],"additionalProperties":false},"AlphaConnectorAccessRequestsCreateRequest":{"type":"object","properties":{"turnId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The Alpha turn whose answer carries the card"},"itemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The blocked card item's id"},"note":{"description":"Why you need it, in your own words","type":"string","minLength":1,"maxLength":1000}},"required":["turnId","itemId"],"additionalProperties":false},"AlphaConnectorAccessRequestsCreateResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"connector":{"type":"object","properties":{"uid":{"type":"string","minLength":1,"maxLength":384},"service":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,39}$","description":"The connector's service key, such as linear"},"label":{"type":"string","minLength":1,"maxLength":80}},"required":["uid","service","label"],"additionalProperties":false},"action":{"anyOf":[{"type":"object","properties":{"name":{"type":"string","maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:/-]*$","description":"The action's name as the service lists it, such as create_issue"},"title":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]}},"required":["name","title"],"additionalProperties":false},{"type":"null"}]},"requestedBy":{"type":"object","properties":{"userId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":320}},"required":["userId","name"],"additionalProperties":false},"conversationId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"reason":{"type":"string","minLength":1,"maxLength":2000},"proposedInput":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/JsonValue"}},{"type":"null"}]},"status":{"type":"string","enum":["open","unblocked","declined"]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"decidedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"decidedBy":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["id","connector","action","requestedBy","conversationId","reason","proposedInput","status","createdAt","decidedAt","decidedBy"],"additionalProperties":false},"AlphaConnectorAccessRequestsListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/AlphaConnectorAccessRequestsDecideResponse"}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"AlphaConnectorAccessRequestsDecideRequest":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"decision":{"type":"string","enum":["unblock","decline"]}},"required":["requestId","decision"],"additionalProperties":false},"AlphaConnectorAccessRequestsDecideResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"connector":{"type":"object","properties":{"uid":{"type":"string","minLength":1,"maxLength":384},"service":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,39}$","description":"The connector's service key, such as linear"},"label":{"type":"string","minLength":1,"maxLength":80}},"required":["uid","service","label"],"additionalProperties":false},"action":{"anyOf":[{"type":"object","properties":{"name":{"type":"string","maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:/-]*$","description":"The action's name as the service lists it, such as create_issue"},"title":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]}},"required":["name","title"],"additionalProperties":false},{"type":"null"}]},"requestedBy":{"type":"object","properties":{"userId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":320}},"required":["userId","name"],"additionalProperties":false},"conversationId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"reason":{"type":"string","minLength":1,"maxLength":2000},"proposedInput":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/JsonValue"}},{"type":"null"}]},"status":{"type":"string","enum":["open","unblocked","declined"]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"decidedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"decidedBy":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["id","connector","action","requestedBy","conversationId","reason","proposedInput","status","createdAt","decidedAt","decidedBy"],"additionalProperties":false},"AlphaChatOptionsGetResponse":{"type":"object","properties":{"advisorStarters":{"anyOf":[{"maxItems":3,"type":"array","items":{"type":"object","properties":{"actionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"title":{"type":"string"}},"required":["actionId","title"],"additionalProperties":false}},{"type":"null"}],"description":"The organization's first open Advisor actions that are not set aside, in Advisor's order, which a new chat offers to start from; null when they cannot be read"},"models":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"modelId":{"type":"string"},"name":{"type":"string"}},"required":["modelId","name"],"additionalProperties":false}},{"type":"null"}],"description":"The application-managed model; null when none is assigned or it cannot be read"},"brandDefaultArtifactId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The Brand Kit revision a question with no brand choice uses; null when no kit is ready"},"connectors":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"uid":{"type":"string","minLength":1,"description":"The connector's stable product id"},"service":{"type":"string"},"label":{"type":"string"},"status":{"type":"string","enum":["connected","not_connected","setup_required","environment_disabled","unavailable","coming_soon"]},"account":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The provider-side account the connection reports, when connected"}},"required":["uid","service","label","status","account"],"additionalProperties":false}},{"type":"null"}],"description":"The member's own tool connections; empty while viewing as a member"},"intents":{"type":"array","items":{"type":"string","enum":["presentation","spreadsheet","document","pdf","ads","page","image"]},"description":"The kinds of work Alpha can create here, as a question's intent names them"},"officeSuite":{"anyOf":[{"type":"string","enum":["google","microsoft"]},{"type":"null"}],"description":"The suite a file's Open in names for the member (their last copy, then their sign-in, then their email's provider); null offers both, and is always null while viewing as a member"}},"required":["advisorStarters","models","brandDefaultArtifactId","connectors","intents","officeSuite"],"additionalProperties":false},"AlphaTranscriptionsCreateRequest":{"type":"object","properties":{"audio":{"type":"string","maxLength":4194304,"format":"base64","contentEncoding":"base64","pattern":"^$|^(?:[0-9a-zA-Z+/]{4})*(?:(?:[0-9a-zA-Z+/]{2}==)|(?:[0-9a-zA-Z+/]{3}=))?$","description":"The recording's bytes, base64-encoded: at most 3145728 bytes once decoded"},"mediaType":{"type":"string","maxLength":255,"description":"The recording's media type: audio/webm, audio/mp4, audio/wav (a codecs parameter is accepted)"}},"required":["audio","mediaType"],"additionalProperties":false},"AlphaTranscriptionsCreateResponse":{"type":"object","properties":{"text":{"type":"string","description":"The transcript; empty when no speech was recognized"}},"required":["text"],"additionalProperties":false},"AlphaConversationsGetResponse":{"type":"object","properties":{"conversation":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"title":{"type":"string","minLength":1,"maxLength":120},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"messages":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"metadata":{"$ref":"#/components/schemas/AlphaMetadata"},"role":{"type":"string","const":"user"},"parts":{"type":"array","prefixItems":[{"type":"object","properties":{"type":{"type":"string","const":"text"},"text":{"type":"string","minLength":1,"maxLength":65536}},"required":["type","text"],"additionalProperties":false}],"items":{"type":"object","properties":{"type":{"type":"string","const":"file"},"mediaType":{"type":"string","enum":["text/plain","text/csv","application/json","text/markdown","text/html","application/vnd.openxmlformats-officedocument.wordprocessingml.document","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","image/png","image/jpeg","image/webp","application/pdf"]},"filename":{"type":"string","minLength":1,"maxLength":255},"url":{"type":"string","pattern":"^\\/app\\/api\\/ask-data\\/attachments\\/[0-9a-f-]{36}$","description":"The dashboard's link to the file, for a signed-in browser only; API callers read it with alpha.attachments.download by the attachment id in metadata.attachments"}},"required":["type","mediaType","url"],"additionalProperties":false}}},"required":["id","metadata","role","parts"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"metadata":{"$ref":"#/components/schemas/AlphaMetadata"},"role":{"type":"string","const":"assistant"},"parts":{"type":"array","prefixItems":[{"type":"object","properties":{"type":{"type":"string","const":"text"},"text":{"type":"string","minLength":1,"maxLength":65536}},"required":["type","text"],"additionalProperties":false},{"$ref":"#/components/schemas/AlphaParts"}],"items":{"$ref":"#/components/schemas/AlphaPartsItem"}}},"required":["id","metadata","role","parts"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"metadata":{"$ref":"#/components/schemas/AlphaMetadata"},"role":{"type":"string","const":"assistant"},"parts":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/AlphaPartsItemVariant2"},{"$ref":"#/components/schemas/AlphaPartsItemVariant"},{"$ref":"#/components/schemas/AlphaParts"},{"type":"object","properties":{"type":{"type":"string","const":"data-turn-state"},"data":{"type":"object","properties":{"status":{"type":"string","enum":["running","failed","cancelled"]},"failureCode":{"type":"string","minLength":1,"maxLength":160},"message":{"type":"string","minLength":1,"maxLength":1000},"retryable":{"type":"boolean"}},"required":["status","retryable"],"additionalProperties":false}},"required":["type","data"],"additionalProperties":false}]}}},"required":["id","metadata","role","parts"],"additionalProperties":false}]}},"nextBeforeMessageIndex":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]}},"required":["id","title","createdAt","updatedAt","messages","nextBeforeMessageIndex"],"additionalProperties":false},"sharing":{"$ref":"#/components/schemas/AlphaSharing"},"focus":{"anyOf":[{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"advisor_action"},"actionId":{"type":"string"}},"required":["kind","actionId"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"win_customer"},"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","requestId"],"additionalProperties":false}]},{"type":"null"}],"description":"The case this conversation works with its member: an Advisor action to ship or a Win This Customer project; null for an ordinary chat"},"plan":{"$ref":"#/components/schemas/AlphaPlan"},"planVersions":{"$ref":"#/components/schemas/AlphaPlanVersions"}},"required":["conversation","sharing","focus","plan","planVersions"],"additionalProperties":false},"AlphaConversationsGetEvent":{"type":"object","properties":{"type":{"type":"string"}},"required":["type"],"additionalProperties":{},"description":"One AI SDK UI message stream chunk of the turn, projected for its reader"},"AlphaConversationsGetV2Response":{"type":"object","properties":{"conversation":{"$ref":"#/components/schemas/AlphaConversation"},"sharing":{"$ref":"#/components/schemas/AlphaSharing"},"focus":{"anyOf":[{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"advisor_action"},"actionId":{"type":"string"}},"required":["kind","actionId"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"win_customer"},"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","requestId"],"additionalProperties":false}]},{"type":"null"}],"description":"The case this conversation works with its member: an Advisor action to ship or a Win This Customer project; null for an ordinary chat"},"plan":{"$ref":"#/components/schemas/AlphaPlan"},"planVersions":{"$ref":"#/components/schemas/AlphaPlanVersions"}},"required":["conversation","sharing","focus","plan","planVersions"],"additionalProperties":false},"AlphaConversationsGetV2Event":{"type":"object","properties":{"type":{"type":"string"}},"required":["type"],"additionalProperties":{},"description":"One AI SDK UI message stream chunk of the turn, projected for its reader"},"AlphaConversationsGetV3Response":{"type":"object","properties":{"conversation":{"$ref":"#/components/schemas/AlphaConversation"},"sharing":{"$ref":"#/components/schemas/AlphaSharing"},"focus":{"anyOf":[{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"advisor_action"},"actionId":{"type":"string"}},"required":["kind","actionId"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"win_customer"},"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","requestId"],"additionalProperties":false}]},{"type":"null"}],"description":"The case this conversation works with its member: an Advisor action to ship or a Win This Customer project; null for an ordinary chat"},"plan":{"$ref":"#/components/schemas/AlphaPlan2"},"planTrack":{"$ref":"#/components/schemas/AlphaPlanTrack"},"planVersions":{"$ref":"#/components/schemas/AlphaPlanVersions2"}},"required":["conversation","sharing","focus","plan","planTrack","planVersions"],"additionalProperties":false},"AlphaConversationsGetV4Response":{"type":"object","properties":{"conversation":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"title":{"type":"string","minLength":1,"maxLength":120},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/AlphaConversationMessagesItem"}},"nextBeforeMessageIndex":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]}},"required":["id","title","createdAt","updatedAt","messages","nextBeforeMessageIndex"],"additionalProperties":false},"sharing":{"$ref":"#/components/schemas/AlphaSharing"},"focus":{"anyOf":[{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"advisor_action"},"actionId":{"type":"string"}},"required":["kind","actionId"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"win_customer"},"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","requestId"],"additionalProperties":false}]},{"type":"null"}],"description":"The case this conversation works with its member: an Advisor action to ship or a Win This Customer project; null for an ordinary chat"},"plan":{"$ref":"#/components/schemas/AlphaPlan2"},"planTrack":{"$ref":"#/components/schemas/AlphaPlanTrack"},"planVersions":{"$ref":"#/components/schemas/AlphaPlanVersions2"}},"required":["conversation","sharing","focus","plan","planTrack","planVersions"],"additionalProperties":false},"AlphaConversationPlansGetResponse":{"type":"object","properties":{"version":{"type":"object","properties":{"conversationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"plan":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":120},"goal":{"type":"string","minLength":1,"maxLength":200},"thinking":{"type":"string","minLength":1,"maxLength":2000},"steps":{"maxItems":40,"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":80},"title":{"type":"string","minLength":1,"maxLength":160},"why":{"type":"string","minLength":1,"maxLength":400},"performer":{"type":"string","enum":["alpha","person"]},"minutes":{"type":"integer","exclusiveMinimum":0,"maximum":100000},"status":{"type":"string","enum":["todo","doing","done","needs_you","skipped"]},"note":{"anyOf":[{"type":"string","minLength":1,"maxLength":400},{"type":"null"}]}},"required":["key","title","why","performer","minutes","status","note"],"additionalProperties":false}}},"required":["title","goal","thinking","steps"],"additionalProperties":false},"turnId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["conversationId","revision","plan","turnId","createdAt"],"additionalProperties":false,"description":"The version with its body"},"track":{"type":"object","properties":{"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"thinking":{"anyOf":[{"type":"string","minLength":1,"maxLength":2000},{"type":"null"}]},"rows":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":80},"title":{"type":"string","minLength":1,"maxLength":160},"performer":{"type":"string","enum":["alpha","person"]},"status":{"type":"string","enum":["todo","doing","done","needs_you","skipped","removed"]},"note":{"anyOf":[{"type":"string","minLength":1,"maxLength":400},{"type":"null"}]},"added":{"type":"boolean"}},"required":["key","title","performer","status","note","added"],"additionalProperties":false}},"log":{"$ref":"#/components/schemas/AlphaLog"}},"required":["revision","thinking","rows","log"],"additionalProperties":false,"description":"The version as a running record over every version before it"}},"required":["version","track"],"additionalProperties":false},"AlphaConversationsSendRequest":{"type":"object","properties":{"regenerateTurnId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"question":{"type":"string","minLength":1},"brand":{"type":"object","properties":{"profileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"unbranded":{"type":"boolean"}},"additionalProperties":false},"effort":{"type":"string","enum":["low","xhigh","max"]},"model":{"type":"string","minLength":3,"maxLength":120,"pattern":"^[a-z0-9][a-z0-9-]*\\/[A-Za-z0-9][A-Za-z0-9._:-]*$"},"intent":{"type":"string","enum":["presentation","spreadsheet","document","pdf","ads","page","image"]},"adBrief":{"type":"object","properties":{"type":{"type":"string","enum":["static","search","responsive_display","landing_page"]},"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lossReasonId":{"type":"string","minLength":1,"maxLength":1000},"campaignName":{"type":"string","minLength":1,"maxLength":500},"lossReason":{"type":"string","minLength":1,"maxLength":2000}},"additionalProperties":false},"attachments":{"maxItems":5,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"viewing":{"type":"object","properties":{"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"unit":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["slide","page"]},"index":{"type":"integer","minimum":1,"maximum":9999}},"required":["type","index"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["range","element","state"]},"text":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[^\\u0000-\\u001f\\u007f]+$"}},"required":["type","text"],"additionalProperties":false}]}},"required":["artifactId"],"additionalProperties":false},"useConnectors":{"description":"Use your own connected tools for this question in a conversation where someone else asked a question, sent a file or owns its project. Without it they are used only where you wrote all of that. Never used by an API key or in a conversation an API key started.","type":"boolean"},"connectorContinuation":{"description":"Set only on the continuation Point11 writes after a connector approval or connection, never on a question of your own.","type":"boolean","const":true},"conversationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Alpha conversation ID; a new UUID starts a conversation"}},"required":["question","conversationId"],"additionalProperties":false},"AlphaConversationsSendResponse":{"type":"object","properties":{"runId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The billing.runs ID of the turn, which is its turn ID"},"turnId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"conversationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"status":{"type":"string","enum":["running","succeeded","failed"],"description":"The turn's state right after admission; a known turn id reports its own"}},"required":["runId","turnId","conversationId","status"],"additionalProperties":false},"AlphaConversationsSendEvent":{"type":"object","properties":{"type":{"type":"string"}},"required":["type"],"additionalProperties":{},"description":"One AI SDK UI message stream chunk of the turn, projected for its reader"},"AlphaConversationsUpdateRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Alpha conversation ID"},"title":{"description":"The conversation's new title","type":"string","minLength":1,"maxLength":120},"projectId":{"description":"The member's project to move the conversation into, or null for none","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["id"],"additionalProperties":false},"AlphaConversationsUpdateResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"title":{"type":"string","minLength":1,"maxLength":120},"projectId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["id"],"additionalProperties":false},"AlphaConversationsDeleteRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Alpha conversation ID"}},"required":["id"],"additionalProperties":false},"AlphaConversationsDeleteResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"deleted":{"type":"boolean","const":true}},"required":["id","deleted"],"additionalProperties":false},"AlphaConversationsClearRequest":{"type":"object","properties":{},"additionalProperties":false},"AlphaConversationsClearResponse":{"type":"object","properties":{"deletedCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["deletedCount"],"additionalProperties":false},"AlphaTurnsCancelRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Alpha turn ID"}},"required":["id"],"additionalProperties":false},"AlphaTurnsCancelResponse":{"type":"object","properties":{"turnId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"status":{"type":"string","enum":["stop_requested","already_terminal"]}},"required":["turnId","status"],"additionalProperties":false},"AlphaTurnActivityGetResponse":{"type":"object","properties":{"turns":{"type":"array","items":{"type":"object","properties":{"conversationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Alpha conversation ID"},"turnId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Alpha turn ID"},"title":{"type":"string","description":"The conversation's title, as Recent lists it"},"startedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"When the question was asked"},"surface":{"type":"string","enum":["chat","studio"],"description":"Where the answer's conversation opens: chat (Alpha Chat), or studio (a Studio project's round)"}},"required":["conversationId","turnId","title","startedAt","surface"],"additionalProperties":false},"description":"The member's own answers that have not settled, newest first"},"revision":{"type":"string","description":"Opaque; changes whenever one of the member's answers starts or settles"}},"required":["turns","revision"],"additionalProperties":false},"AlphaTurnEventsGetResponse":{"type":"object","properties":{"turnId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"conversationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"status":{"type":"string","enum":["running","succeeded","failed","cancelled"],"description":"What the turn is now: running while it still works (a follow that ended early is followed again from nextIndex), else what it became"},"nextIndex":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The startIndex to follow from next: the index after the last event sent"}},"required":["turnId","conversationId","status","nextIndex"],"additionalProperties":false},"AlphaTurnEventsGetEvent":{"type":"object","properties":{"index":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}],"description":"The index this event is stored under; a reader that comes back follows from index + 1. Null for an event that is not stored: the opening, a heartbeat, or an outcome read after the turn ended"},"chunks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"}},"required":["type"],"additionalProperties":{},"description":"One AI SDK UI message stream chunk of the turn, projected for its reader"},"description":"AI SDK UI message stream chunks for the turn's message, in order"},"settled":{"description":"On the last event: what the turn became","type":"object","properties":{"status":{"type":"string","enum":["succeeded","failed","cancelled"]},"messages":{"type":"array","items":{"$ref":"#/components/schemas/AlphaConversationMessagesItem"},"description":"The question's messages exactly as alpha.conversations.get returns them: swap them in for the question and what streamed"},"planVersions":{"description":"The conversation's plan versions as alpha.conversations.get lists them, oldest first, when it keeps a plan; a running answer also names each version it saves in a plan-revision chunk","type":"array","items":{"$ref":"#/components/schemas/AlphaItem3"}}},"required":["status","messages"],"additionalProperties":false}},"required":["index","chunks"],"additionalProperties":false},"AlphaTurnsSelectVersionRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The earlier successful answer's turn ID"},"conversationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Alpha conversation ID"},"rootTurnId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The question's first turn ID"}},"required":["id","conversationId","rootTurnId"],"additionalProperties":false},"AlphaTurnsSelectVersionResponse":{"type":"object","properties":{"selected":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["selected"],"additionalProperties":false},"AlphaTurnFeedbackUpdateRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Alpha turn ID"},"conversationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Alpha conversation ID"},"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"An artifact version this answer produced (as alpha.artifacts.get lists it with its turn), when the feedback is about that version rather than the answer"},"feedback":{"oneOf":[{"type":"object","properties":{"rating":{"type":"string","const":"up"},"comment":{"type":"null"},"reasons":{"maxItems":5,"type":"array","items":{"type":"string","enum":["on_brief","accurate","looks_great","on_brand","ready_to_use"]}}},"required":["rating"],"additionalProperties":false},{"type":"object","properties":{"rating":{"type":"string","const":"down"},"comment":{"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}]},"reasons":{"maxItems":7,"type":"array","items":{"type":"string","enum":["off_brief","wrong_numbers","layout_problems","off_brand","hard_to_edit","missing_content","text_errors"]}}},"required":["rating"],"additionalProperties":false}]}},"required":["id","conversationId","feedback"],"additionalProperties":false},"AlphaTurnFeedbackUpdateResponse":{"type":"object","properties":{"turnId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"feedback":{"type":"object","properties":{"rating":{"type":"string","enum":["up","down"]},"comment":{"anyOf":[{"type":"string","minLength":1,"maxLength":2000},{"type":"null"}]},"reasons":{"type":"array","items":{"type":"string","enum":["on_brief","accurate","looks_great","on_brand","ready_to_use","off_brief","wrong_numbers","layout_problems","off_brand","hard_to_edit","missing_content","text_errors"]}},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["rating","comment","updatedAt"],"additionalProperties":false}},"required":["turnId","feedback"],"additionalProperties":false},"AlphaTurnFeedbackGetResponse":{"type":"object","properties":{"turnId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"feedback":{"anyOf":[{"type":"object","properties":{"rating":{"type":"string","enum":["up","down"]},"comment":{"anyOf":[{"type":"string","minLength":1,"maxLength":2000},{"type":"null"}]},"reasons":{"type":"array","items":{"type":"string","enum":["on_brief","accurate","looks_great","on_brand","ready_to_use","off_brief","wrong_numbers","layout_problems","off_brand","hard_to_edit","missing_content","text_errors"]}},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["rating","comment","updatedAt"],"additionalProperties":false},{"type":"null"}]}},"required":["turnId","feedback"],"additionalProperties":false},"AlphaProposedActionsConfirmRequest":{"type":"object","properties":{"turnId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The Alpha turn whose answer proposed the action"},"actionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The proposed action's ID"}},"required":["turnId","actionId"],"additionalProperties":false},"AlphaProposedActionsConfirmResponse":{"type":"object","properties":{"actionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"operationId":{"type":"string","pattern":"^[a-z0-9]+(?:[._-][a-z0-9]+)*\\.v[1-9][0-9]*$"},"status":{"type":"string","const":"accepted"},"receipt":{"$ref":"#/components/schemas/AlphaReceipt"}},"required":["actionId","operationId","status","receipt"],"additionalProperties":false},"AlphaProjectsCreateRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80}},"required":["name"],"additionalProperties":false},"AlphaProjectsCreateResponse":{"type":"object","properties":{"project":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":80},"conversationCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"visibility":{"type":"string","enum":["private","organization"]},"mine":{"type":"boolean"},"ownerName":{"type":"string","minLength":1,"maxLength":320}},"required":["id","name","conversationCount","updatedAt","visibility","mine","ownerName"],"additionalProperties":false}},"required":["project"],"additionalProperties":false},"AlphaProjectsUpdateRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Alpha project ID"},"name":{"type":"string","minLength":1,"maxLength":80},"instructions":{"anyOf":[{"type":"string","minLength":1,"maxLength":8000},{"type":"null"}],"description":"Standing guidance for every chat in the project; null clears it"}},"required":["id"],"additionalProperties":false},"AlphaProjectsUpdateResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Alpha project ID"},"name":{"type":"string","minLength":1,"maxLength":80},"instructions":{"anyOf":[{"type":"string","minLength":1,"maxLength":8000},{"type":"null"}],"description":"Standing guidance for every chat in the project; null clears it"}},"required":["id","name","instructions"],"additionalProperties":false},"AlphaProjectsDeleteRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Alpha project ID"}},"required":["id"],"additionalProperties":false},"AlphaProjectsDeleteResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Alpha project ID"},"deleted":{"type":"boolean","const":true}},"required":["id","deleted"],"additionalProperties":false},"AlphaProjectsSetVisibilityRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Alpha project ID"},"visibility":{"type":"string","enum":["private","organization"]}},"required":["id","visibility"],"additionalProperties":false},"AlphaProjectsSetVisibilityResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Alpha project ID"},"visibility":{"type":"string","enum":["private","organization"]}},"required":["id","visibility"],"additionalProperties":false},"AlphaProjectPinsCreateRequest":{"type":"object","properties":{"projectId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Alpha project ID"},"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"A file's artifact ID, as alpha.files.list lists it"}},"required":["projectId","artifactId"],"additionalProperties":false},"AlphaProjectPinsCreateResponse":{"type":"object","properties":{"projectId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Alpha project ID"},"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"A file's artifact ID, as alpha.files.list lists it"},"pinned":{"type":"boolean","const":true}},"required":["projectId","artifactId","pinned"],"additionalProperties":false},"AlphaProjectPinsDeleteRequest":{"type":"object","properties":{"projectId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Alpha project ID"},"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"A file's artifact ID, as alpha.files.list lists it"}},"required":["projectId","artifactId"],"additionalProperties":false},"AlphaProjectPinsDeleteResponse":{"type":"object","properties":{"projectId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Alpha project ID"},"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"A file's artifact ID, as alpha.files.list lists it"},"deleted":{"type":"boolean","const":true}},"required":["projectId","artifactId","deleted"],"additionalProperties":false},"AlphaConversationMembersListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"userId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"name":{"type":"string","minLength":1,"maxLength":320},"sharedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["userId","name","sharedAt"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"AlphaConversationMembersAddRequest":{"type":"object","properties":{"conversationId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The Alpha conversation"},"email":{"type":"string","maxLength":320,"format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$","description":"The member's email address"}},"required":["conversationId","email"],"additionalProperties":false},"AlphaConversationMembersAddResponse":{"type":"object","properties":{"member":{"type":"object","properties":{"userId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"name":{"type":"string","minLength":1,"maxLength":320},"sharedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["userId","name","sharedAt"],"additionalProperties":false}},"required":["member"],"additionalProperties":false},"AlphaConversationMembersRemoveRequest":{"type":"object","properties":{"conversationId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The Alpha conversation"},"userId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"}},"required":["conversationId","userId"],"additionalProperties":false},"AlphaConversationMembersRemoveResponse":{"type":"object","properties":{"removed":{"type":"boolean"}},"required":["removed"],"additionalProperties":false},"AlphaArtifactsGetResponse":{"type":"object","properties":{"versions":{"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/AlphaData2"}},"content":{"anyOf":[{"type":"string"},{"type":"null"}]},"conversationId":{"description":"The conversation that holds the file, for opening it there","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"turnIds":{"type":"object","propertyNames":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"additionalProperties":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},"required":["versions","content"],"additionalProperties":false},"AlphaArtifactsOutlineResponse":{"type":"object","properties":{"structure":{"anyOf":[{"oneOf":[{"type":"object","properties":{"format":{"type":"string","const":"pptx"},"layouts":{"maxItems":1000,"type":"array","items":{"type":"string","maxLength":1024}},"slides":{"maxItems":60,"type":"array","items":{"type":"object","properties":{"number":{"type":"integer","minimum":1,"maximum":9007199254740991},"layout":{"type":"string","maxLength":1024},"shapes":{"maxItems":5000,"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","minimum":0,"maximum":9007199254740991},"name":{"type":"string","maxLength":4096},"kind":{"type":"string","enum":["text","shape","picture","chart","table","diagram","object","group","connector"]},"placeholder":{"type":"string","maxLength":64},"paragraphs":{"maxItems":200,"type":"array","items":{"type":"string","maxLength":4096}},"clipped":{"type":"boolean","const":true},"altText":{"type":"string","maxLength":4096}},"required":["id","name","kind"],"additionalProperties":false}},"notes":{"type":"string","maxLength":4096},"notesClipped":{"type":"boolean","const":true}},"required":["number","shapes"],"additionalProperties":false}}},"required":["format","layouts","slides"],"additionalProperties":false},{"type":"object","properties":{"format":{"type":"string","const":"docx"},"styles":{"maxItems":200,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","maxLength":1024},"name":{"type":"string","maxLength":1024}},"required":["id","name"],"additionalProperties":false}},"truncated":{"type":"boolean"},"paragraphs":{"maxItems":4000,"type":"array","items":{"type":"object","properties":{"number":{"type":"integer","minimum":1,"maximum":9007199254740991},"style":{"type":"string","maxLength":1024},"text":{"type":"string","maxLength":4096},"runs":{"maxItems":40,"type":"array","items":{"type":"string","maxLength":4096}},"clipped":{"type":"boolean","const":true},"bookmarks":{"maxItems":20,"type":"array","items":{"type":"string","maxLength":1024}}},"required":["number","text"],"additionalProperties":false}}},"required":["format","styles","truncated","paragraphs"],"additionalProperties":false},{"type":"object","properties":{"format":{"type":"string","const":"xlsx"},"sheets":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":1024},"dimension":{"type":"string","maxLength":64},"charts":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"type":{"type":"string","maxLength":64},"title":{"type":"string","maxLength":4096}},"required":["type"],"additionalProperties":false}}},"required":["name","charts"],"additionalProperties":false}}},"required":["format","sheets"],"additionalProperties":false}]},{"type":"null"}],"description":"What this version holds; null when it was saved before outlines were recorded"}},"required":["structure"],"additionalProperties":false},"AlphaArtifactsEditRequest":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The latest version of the saved pptx, docx or xlsx to edit"},"ops":{"minItems":1,"maxItems":200,"type":"array","items":{"oneOf":[{"type":"object","properties":{"op":{"type":"string","const":"set_shape_text"},"slide":{"type":"integer","minimum":1,"maximum":60},"shape":{"anyOf":[{"type":"object","properties":{"shapeId":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["shapeId"],"additionalProperties":false},{"type":"object","properties":{"shapeName":{"type":"string","minLength":1,"maxLength":255}},"required":["shapeName"],"additionalProperties":false},{"type":"object","properties":{"placeholder":{"type":"string","enum":["title","subtitle","body"]}},"required":["placeholder"],"additionalProperties":false}]},"paragraphs":{"minItems":1,"maxItems":200,"type":"array","items":{"anyOf":[{"type":"string","maxLength":20000},{"type":"object","properties":{"text":{"type":"string","maxLength":20000},"level":{"type":"integer","minimum":0,"maximum":8}},"required":["text","level"],"additionalProperties":false}]}}},"required":["op","slide","shape","paragraphs"],"additionalProperties":false},{"type":"object","properties":{"op":{"type":"string","const":"set_notes"},"slide":{"type":"integer","minimum":1,"maximum":60},"text":{"type":"string","maxLength":20000}},"required":["op","slide","text"],"additionalProperties":false},{"type":"object","properties":{"op":{"type":"string","const":"delete_slide"},"slide":{"type":"integer","minimum":1,"maximum":60}},"required":["op","slide"],"additionalProperties":false},{"type":"object","properties":{"op":{"type":"string","const":"duplicate_slide"},"slide":{"type":"integer","minimum":1,"maximum":60},"position":{"type":"integer","minimum":1,"maximum":60}},"required":["op","slide"],"additionalProperties":false},{"type":"object","properties":{"op":{"type":"string","const":"move_slide"},"slide":{"type":"integer","minimum":1,"maximum":60},"to":{"type":"integer","minimum":1,"maximum":60}},"required":["op","slide","to"],"additionalProperties":false},{"type":"object","properties":{"op":{"type":"string","const":"replace_image"},"slide":{"type":"integer","minimum":1,"maximum":60},"shape":{"anyOf":[{"type":"object","properties":{"shapeId":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["shapeId"],"additionalProperties":false},{"type":"object","properties":{"shapeName":{"type":"string","minLength":1,"maxLength":255}},"required":["shapeName"],"additionalProperties":false}]},"imageArtifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"altText":{"type":"string","minLength":1,"maxLength":1000}},"required":["op","slide","shape","imageArtifactId"],"additionalProperties":false},{"type":"object","properties":{"op":{"type":"string","const":"add_slide"},"layout":{"type":"string","minLength":1,"maxLength":255},"placeholders":{"maxItems":24,"type":"array","items":{"type":"object","properties":{"placeholder":{"anyOf":[{"type":"string","enum":["title","subtitle","body","picture"]},{"type":"integer","minimum":0,"maximum":9007199254740991}],"description":"The layout's placeholder: title, subtitle, body, picture, or its idx number."},"paragraphs":{"minItems":1,"maxItems":200,"type":"array","items":{"anyOf":[{"type":"string","maxLength":20000},{"type":"object","properties":{"text":{"type":"string","maxLength":20000},"level":{"type":"integer","minimum":0,"maximum":8}},"required":["text","level"],"additionalProperties":false}]}},"imageArtifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"altText":{"type":"string","minLength":1,"maxLength":1000}},"required":["placeholder"],"additionalProperties":false}},"notes":{"type":"string","maxLength":20000},"position":{"type":"integer","minimum":1,"maximum":60}},"required":["op","layout","placeholders"],"additionalProperties":false},{"type":"object","properties":{"op":{"type":"string","const":"set_paragraph_text"},"paragraph":{"type":"integer","minimum":1,"maximum":9007199254740991},"bookmark":{"type":"string","minLength":1,"maxLength":40},"text":{"type":"string","maxLength":20000}},"required":["op","text"],"additionalProperties":false},{"type":"object","properties":{"op":{"type":"string","const":"set_run_text"},"paragraph":{"type":"integer","minimum":1,"maximum":9007199254740991},"run":{"type":"integer","minimum":1,"maximum":9007199254740991},"text":{"type":"string","maxLength":20000}},"required":["op","paragraph","run","text"],"additionalProperties":false},{"type":"object","properties":{"op":{"type":"string","const":"insert_paragraph"},"after":{"type":"integer","minimum":0,"maximum":9007199254740991},"text":{"type":"string","maxLength":20000},"style":{"type":"string","minLength":1,"maxLength":253}},"required":["op","after","text"],"additionalProperties":false},{"type":"object","properties":{"op":{"type":"string","const":"set_cell"},"sheet":{"type":"string","minLength":1,"maxLength":31},"cell":{"type":"string","pattern":"^\\$?[A-Za-z]{1,3}\\$?[1-9][0-9]{0,6}$"},"value":{"anyOf":[{"type":"string","maxLength":32767},{"type":"number"},{"type":"boolean"},{"type":"null"}]},"formula":{"type":"string","minLength":1,"maxLength":8192}},"required":["op","sheet","cell"],"additionalProperties":false},{"type":"object","properties":{"op":{"type":"string","const":"add_chart"},"sheet":{"type":"string","minLength":1,"maxLength":31},"type":{"type":"string","enum":["bar","column","line","pie","scatter"]},"title":{"type":"string","maxLength":255},"categories":{"type":"string","minLength":2,"maxLength":300},"series":{"minItems":1,"maxItems":255,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":255},"nameCell":{"type":"string","pattern":"^\\$?[A-Za-z]{1,3}\\$?[1-9][0-9]{0,6}$"},"values":{"type":"string","minLength":2,"maxLength":300},"xValues":{"type":"string","minLength":2,"maxLength":300}},"required":["values"],"additionalProperties":false}},"categoryAxisTitle":{"type":"string","maxLength":255},"valueAxisTitle":{"type":"string","maxLength":255},"legend":{"type":"boolean"},"anchor":{"type":"object","properties":{"from":{"type":"string","pattern":"^\\$?[A-Za-z]{1,3}\\$?[1-9][0-9]{0,6}$"},"to":{"type":"string","pattern":"^\\$?[A-Za-z]{1,3}\\$?[1-9][0-9]{0,6}$"}},"required":["from","to"],"additionalProperties":false},"altText":{"type":"string","minLength":1,"maxLength":1000}},"required":["op","sheet","type","series"],"additionalProperties":false}]},"description":"The operations, applied in order to the saved file, all or nothing"},"title":{"description":"The new version's title","type":"string","minLength":1,"maxLength":160}},"required":["id","ops"],"additionalProperties":false},"AlphaArtifactsEditResponse":{"type":"object","properties":{"adSuite":{"$ref":"#/components/schemas/AlphaAdSuite"},"artifactPackage":{"$ref":"#/components/schemas/AlphaArtifactPackage"},"calculation":{"type":"object","properties":{"status":{"type":"string","enum":["recalculated","unavailable"]},"engine":{"type":"string","const":"libreoffice"},"formulaCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"findings":{"type":"array","items":{"type":"object","properties":{"sheet":{"type":"string"},"cell":{"type":"string"},"error":{"type":"string"}},"required":["sheet","cell","error"],"additionalProperties":false}}},"required":["status","engine","formulaCount","findings"],"additionalProperties":false},"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"kind":{"type":"string","enum":["markdown","slides","image","audio","video","brand_kit","presentation","spreadsheet","word","pdf","csv","page"]},"title":{"type":"string","minLength":1,"maxLength":160},"mediaType":{"type":"string","enum":["text/markdown","application/vnd.point11.slides+json","image/png","image/jpeg","image/webp","audio/mpeg","audio/wav","video/mp4","video/webm","application/vnd.point11.brand-kit+json","application/vnd.openxmlformats-officedocument.presentationml.presentation","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","application/vnd.openxmlformats-officedocument.wordprocessingml.document","application/pdf","text/csv","text/html","application/vnd.point11.website+json"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":1073741824},"status":{"type":"string","const":"ready"},"revisesArtifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"brandName":{"type":"string","minLength":1,"maxLength":120},"slideCount":{"type":"integer","exclusiveMinimum":0,"maximum":60},"previewArtifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"previewFailure":{"type":"string","enum":["render_failed","invalid_preview","upload_failed"]},"websitePreview":{"$ref":"#/components/schemas/AlphaWebsitePreview"},"websitePreviewFailure":{"type":"string","enum":["capture_failed","upload_failed"]},"evidence":{"maxItems":512,"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["query_run","verified_metric","web_source","attachment","artifact"]},"id":{"type":"string","minLength":1,"maxLength":400},"observedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["kind","id","observedAt"],"additionalProperties":false}},"purpose":{"type":"string","enum":["deliverable","working"]}},"required":["artifactId","kind","title","mediaType","byteLength"],"additionalProperties":false},"AlphaArtifactsDownloadResponse":{"type":"object","properties":{"filename":{"type":"string","minLength":1,"description":"Suggested file name for saving the bytes"},"contentType":{"type":"string","minLength":1},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Short-lived presigned URL that GETs the bytes; null when this deployment cannot sign the object"},"expiresAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}],"description":"When url stops working (minutes after the call); null with url"},"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The version whose bytes these are"}},"required":["filename","contentType","byteLength","url","expiresAt","id"],"additionalProperties":false},"AlphaArtifactInspectionsGetResponse":{"type":"object","properties":{"sha256":{"type":"string"},"inspection":{"anyOf":[{"type":"object","properties":{"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"coverage":{"minItems":1,"type":"array","items":{"type":"object","properties":{"renderedArtifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"page":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"The one-based PDF page number, also for a page inspect_artifact drew as an image. Use a separate coverage entry for every page; omit for an image artifact."},"label":{"type":"string","minLength":1,"maxLength":500}},"required":["renderedArtifactId","label"],"additionalProperties":false},"description":"One entry per inspected PDF page or image. Never summarize several PDF pages in one entry's label."},"outcome":{"type":"string","enum":["checked","needs_changes"],"description":"needs_changes when at least one finding is an error; otherwise checked."},"findings":{"type":"array","items":{"type":"object","properties":{"severity":{"type":"string","enum":["info","warning","error"],"description":"error only for what must be fixed before the person uses the deliverable: a number, name or claim the evidence or brief does not support, a broken, clipped or unreadable render, or a requirement the request stated that is missing. warning or info for everything else."},"message":{"type":"string","minLength":1,"maxLength":4000},"location":{"type":"string","maxLength":500}},"required":["severity","message"],"additionalProperties":false}},"sourceArtifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sourceSha256":{"type":"string","pattern":"^[a-f0-9]{64}$"},"retainedCoverage":{"type":"array","items":{"type":"object","properties":{"sourceArtifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$"}},"required":["sourceArtifactId","artifactId","sha256"],"additionalProperties":false}},"runId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"reviewedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"inspectedBy":{"type":"string","const":"model"}},"required":["artifactId","coverage","outcome","findings","runId","reviewedAt","inspectedBy"],"additionalProperties":false},{"type":"null"}],"description":"What the model recorded when it reviewed this version; null when none was"}},"required":["sha256","inspection"],"additionalProperties":false},"AlphaArtifactPackagesGetResponse":{"type":"object","properties":{"artifact":{"$ref":"#/components/schemas/AlphaData2"},"members":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/AlphaData2"},{"type":"null"}]}}},"required":["artifact","members"],"additionalProperties":false},"AlphaArtifactPackagesExportResponse":{"type":"object","properties":{"filename":{"type":"string","minLength":1,"description":"Suggested name for the assembled .zip"},"entries":{"$ref":"#/components/schemas/AlphaEntries"}},"required":["filename","entries"],"additionalProperties":false},"AlphaWebsitesExportResponse":{"type":"object","properties":{"filename":{"type":"string","minLength":1,"description":"Suggested name for the assembled .zip"},"entries":{"$ref":"#/components/schemas/AlphaEntries"}},"required":["filename","entries"],"additionalProperties":false},"AlphaWebsitesEditTextRequest":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The website version shown when the element was picked"},"path":{"type":"string","minLength":1,"maxLength":240,"description":"The source file the element picker named (data-p11-src)"},"line":{"type":"integer","minimum":1,"maximum":999999,"description":"The element's one-based line in that file"},"column":{"type":"integer","minimum":1,"maximum":999999,"description":"The element's one-based column on that line"},"find":{"type":"string","minLength":1,"maxLength":2000,"description":"The text the element shows"},"replace":{"type":"string","minLength":1,"maxLength":2000,"description":"The text it should show"}},"required":["id","path","line","column","find","replace"],"additionalProperties":false},"AlphaWebsitesEditTextResponse":{"type":"object","properties":{"adSuite":{"$ref":"#/components/schemas/AlphaAdSuite"},"artifactPackage":{"$ref":"#/components/schemas/AlphaArtifactPackage"},"calculation":{"type":"object","properties":{"status":{"type":"string","enum":["recalculated","unavailable"]},"engine":{"type":"string","const":"libreoffice"},"formulaCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"findings":{"type":"array","items":{"type":"object","properties":{"sheet":{"type":"string"},"cell":{"type":"string"},"error":{"type":"string"}},"required":["sheet","cell","error"],"additionalProperties":false}}},"required":["status","engine","formulaCount","findings"],"additionalProperties":false},"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"kind":{"type":"string","enum":["markdown","slides","image","audio","video","brand_kit","presentation","spreadsheet","word","pdf","csv","page"]},"title":{"type":"string","minLength":1,"maxLength":160},"mediaType":{"type":"string","enum":["text/markdown","application/vnd.point11.slides+json","image/png","image/jpeg","image/webp","audio/mpeg","audio/wav","video/mp4","video/webm","application/vnd.point11.brand-kit+json","application/vnd.openxmlformats-officedocument.presentationml.presentation","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","application/vnd.openxmlformats-officedocument.wordprocessingml.document","application/pdf","text/csv","text/html","application/vnd.point11.website+json"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":1073741824},"status":{"type":"string","const":"ready"},"revisesArtifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"brandName":{"type":"string","minLength":1,"maxLength":120},"slideCount":{"type":"integer","exclusiveMinimum":0,"maximum":60},"previewArtifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"previewFailure":{"type":"string","enum":["render_failed","invalid_preview","upload_failed"]},"websitePreview":{"$ref":"#/components/schemas/AlphaWebsitePreview"},"websitePreviewFailure":{"type":"string","enum":["capture_failed","upload_failed"]},"evidence":{"maxItems":512,"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["query_run","verified_metric","web_source","attachment","artifact"]},"id":{"type":"string","minLength":1,"maxLength":400},"observedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["kind","id","observedAt"],"additionalProperties":false}},"purpose":{"type":"string","enum":["deliverable","working"]}},"required":["artifactId","kind","title","mediaType","byteLength"],"additionalProperties":false},"AlphaArtifactsReviseRequest":{"type":"object","properties":{"revisesArtifactId":{"description":"The latest version read by read_artifact when editing an existing document; omit only for a new document.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"brandKitArtifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"unbranded":{"type":"boolean"},"kind":{"type":"string","enum":["markdown","csv"],"description":"markdown: a Markdown document. csv: a CSV file to download. Presentations use create_file with format pptx."},"title":{"type":"string","minLength":1,"maxLength":160},"deliverable":{"description":"false for a working file that only another step reads, such as a CSV written for run_analysis or create_file: it folds under the answer and stays out of the person's Files list. Omit it for a document or CSV the person asked for. A new version keeps its file's choice, so omit it with revisesArtifactId.","type":"boolean"},"markdown":{"description":"The document. Required when kind is markdown.","type":"string","minLength":1,"maxLength":65536},"csv":{"description":"The file's text: a header row first, RFC 4180 quoting, one record per line. Required when kind is csv.","type":"string","minLength":1,"maxLength":200000},"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The ID of any version of a file Alpha made"}},"required":["kind","title","id"],"additionalProperties":false},"AlphaArtifactsReviseResponse":{"type":"object","properties":{"adSuite":{"$ref":"#/components/schemas/AlphaAdSuite"},"artifactPackage":{"$ref":"#/components/schemas/AlphaArtifactPackage"},"calculation":{"type":"object","properties":{"status":{"type":"string","enum":["recalculated","unavailable"]},"engine":{"type":"string","const":"libreoffice"},"formulaCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"findings":{"type":"array","items":{"type":"object","properties":{"sheet":{"type":"string"},"cell":{"type":"string"},"error":{"type":"string"}},"required":["sheet","cell","error"],"additionalProperties":false}}},"required":["status","engine","formulaCount","findings"],"additionalProperties":false},"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"kind":{"type":"string","enum":["markdown","slides","image","audio","video","brand_kit","presentation","spreadsheet","word","pdf","csv","page"]},"title":{"type":"string","minLength":1,"maxLength":160},"mediaType":{"type":"string","enum":["text/markdown","application/vnd.point11.slides+json","image/png","image/jpeg","image/webp","audio/mpeg","audio/wav","video/mp4","video/webm","application/vnd.point11.brand-kit+json","application/vnd.openxmlformats-officedocument.presentationml.presentation","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","application/vnd.openxmlformats-officedocument.wordprocessingml.document","application/pdf","text/csv","text/html","application/vnd.point11.website+json"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":1073741824},"status":{"type":"string","const":"ready"},"revisesArtifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"brandName":{"type":"string","minLength":1,"maxLength":120},"slideCount":{"type":"integer","exclusiveMinimum":0,"maximum":60},"previewArtifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"previewFailure":{"type":"string","enum":["render_failed","invalid_preview","upload_failed"]},"websitePreview":{"$ref":"#/components/schemas/AlphaWebsitePreview"},"websitePreviewFailure":{"type":"string","enum":["capture_failed","upload_failed"]},"evidence":{"maxItems":512,"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["query_run","verified_metric","web_source","attachment","artifact"]},"id":{"type":"string","minLength":1,"maxLength":400},"observedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["kind","id","observedAt"],"additionalProperties":false}},"purpose":{"type":"string","enum":["deliverable","working"]}},"required":["artifactId","kind","title","mediaType","byteLength"],"additionalProperties":false},"AlphaArtifactsRestoreRequest":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The earlier version whose content becomes the newest version"},"revisesArtifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The newest version you read; the restore is refused once a newer version exists"}},"required":["id","revisesArtifactId"],"additionalProperties":false},"AlphaArtifactsRestoreResponse":{"type":"object","properties":{"adSuite":{"$ref":"#/components/schemas/AlphaAdSuite"},"artifactPackage":{"$ref":"#/components/schemas/AlphaArtifactPackage"},"calculation":{"type":"object","properties":{"status":{"type":"string","enum":["recalculated","unavailable"]},"engine":{"type":"string","const":"libreoffice"},"formulaCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"findings":{"type":"array","items":{"type":"object","properties":{"sheet":{"type":"string"},"cell":{"type":"string"},"error":{"type":"string"}},"required":["sheet","cell","error"],"additionalProperties":false}}},"required":["status","engine","formulaCount","findings"],"additionalProperties":false},"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"kind":{"type":"string","enum":["markdown","slides","image","audio","video","brand_kit","presentation","spreadsheet","word","pdf","csv","page"]},"title":{"type":"string","minLength":1,"maxLength":160},"mediaType":{"type":"string","enum":["text/markdown","application/vnd.point11.slides+json","image/png","image/jpeg","image/webp","audio/mpeg","audio/wav","video/mp4","video/webm","application/vnd.point11.brand-kit+json","application/vnd.openxmlformats-officedocument.presentationml.presentation","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","application/vnd.openxmlformats-officedocument.wordprocessingml.document","application/pdf","text/csv","text/html","application/vnd.point11.website+json"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":1073741824},"status":{"type":"string","const":"ready"},"revisesArtifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"brandName":{"type":"string","minLength":1,"maxLength":120},"slideCount":{"type":"integer","exclusiveMinimum":0,"maximum":60},"previewArtifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"previewFailure":{"type":"string","enum":["render_failed","invalid_preview","upload_failed"]},"websitePreview":{"$ref":"#/components/schemas/AlphaWebsitePreview"},"websitePreviewFailure":{"type":"string","enum":["capture_failed","upload_failed"]},"evidence":{"maxItems":512,"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["query_run","verified_metric","web_source","attachment","artifact"]},"id":{"type":"string","minLength":1,"maxLength":400},"observedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["kind","id","observedAt"],"additionalProperties":false}},"purpose":{"type":"string","enum":["deliverable","working"]}},"required":["artifactId","kind","title","mediaType","byteLength"],"additionalProperties":false},"AlphaArtifactsRenameRequest":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"Any version of the file"},"title":{"anyOf":[{"type":"string","minLength":1,"maxLength":160},{"type":"null"}],"description":"The file's new name; null returns it to the name Alpha gave it"}},"required":["id","title"],"additionalProperties":false},"AlphaArtifactsRenameResponse":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The version named in the request"},"title":{"type":"string","description":"The name every version now shows"}},"required":["id","title"],"additionalProperties":false},"AlphaArtifactsDeleteRequest":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"Any version of the file"}},"required":["id"],"additionalProperties":false},"AlphaArtifactsDeleteResponse":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"deleted":{"type":"boolean","const":true},"retired":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"How many stored objects (versions, previews, captures) were removed"}},"required":["id","deleted","retired"],"additionalProperties":false},"AlphaMicrosoftFilesGetResponse":{"type":"object","properties":{"file":{"type":"object","properties":{"kind":{"type":"string","const":"preview"},"preview":{"oneOf":[{"type":"object","properties":{"method":{"type":"string","const":"GET"},"url":{"type":"string"}},"required":["method","url"],"additionalProperties":false},{"type":"object","properties":{"method":{"type":"string","const":"POST"},"url":{"type":"string"},"parameters":{"type":"string","minLength":1}},"required":["method","url","parameters"],"additionalProperties":false}]}},"required":["kind","preview"],"additionalProperties":false}},"required":["file"],"additionalProperties":false},"AlphaArtifactsOpenInRequest":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The ID of any version of a file Alpha made"},"app":{"type":"string","enum":["google","microsoft"],"description":"google opens it in Google Slides, Docs or Sheets; microsoft in PowerPoint, Word or Excel for the web"}},"required":["id","app"],"additionalProperties":false},"AlphaArtifactsOpenInResponse":{"type":"object","properties":{"target":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"file"},"url":{"type":"string","format":"uri","description":"Opens the member's copy in the app"},"copy":{"type":"string","enum":["new","existing"],"description":"new: this call made the copy; existing: an earlier call had"}},"required":["kind","url","copy"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"consent"},"url":{"type":"string","format":"uri","description":"The provider's consent for the member's own connection; it returns to the file"}},"required":["kind","url"],"additionalProperties":false}]}},"required":["target"],"additionalProperties":false},"AlphaPagePublicationsGetResponse":{"type":"object","properties":{"publication":{"anyOf":[{"$ref":"#/components/schemas/AlphaPublication"},{"type":"null"}]}},"required":["publication"],"additionalProperties":false},"AlphaPagePublicationsCreateRequest":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The version to publish"}},"required":["id"],"additionalProperties":false},"AlphaPagePublicationsCreateResponse":{"type":"object","properties":{"publication":{"$ref":"#/components/schemas/AlphaPublication"}},"required":["publication"],"additionalProperties":false},"AlphaPagePublicationsUpdateRequest":{"type":"object","properties":{"password":{"anyOf":[{"type":"string","minLength":8,"maxLength":128},{"type":"null"}]},"discoverable":{"type":"boolean"},"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The ID of any version of an Alpha website, deck, PDF, or image"}},"required":["id"],"additionalProperties":false},"AlphaPagePublicationsUpdateResponse":{"type":"object","properties":{"publication":{"$ref":"#/components/schemas/AlphaPublication"}},"required":["publication"],"additionalProperties":false},"AlphaPagePublicationsDeleteRequest":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The ID of any version of an Alpha website, deck, PDF, or image"}},"required":["id"],"additionalProperties":false},"AlphaPagePublicationsDeleteResponse":{"type":"object","properties":{"ended":{"type":"boolean","description":"false when nothing was live"}},"required":["ended"],"additionalProperties":false},"AlphaPageLeadsListResponse":{"type":"object","properties":{"data":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"formId":{"type":"string"},"fields":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"suspectedAutomation":{"type":"boolean"},"submittedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["id","formId","fields","suspectedAutomation","submittedAt"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"forms":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"purpose":{"type":"string"},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"}},"required":["name","label"],"additionalProperties":false}}},"required":["id","purpose","fields"],"additionalProperties":false}},"retentionDays":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"dailyLimit":{"type":"object","properties":{"limit":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"received":{"type":"integer","minimum":0,"maximum":9007199254740991},"reached":{"type":"boolean"}},"required":["limit","received","reached"],"additionalProperties":false}},"required":["data","nextCursor","forms","retentionDays","dailyLimit"],"additionalProperties":false},"AlphaPageLeadsExportResponse":{"type":"object","properties":{"fileName":{"type":"string"},"mediaType":{"type":"string","const":"text/csv"},"content":{"type":"string"},"rowCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["fileName","mediaType","content","rowCount","nextCursor"],"additionalProperties":false},"AlphaPageLeadsDeleteRequest":{"type":"object","properties":{"pageId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The ID of any version of an Alpha page"},"leadIds":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"description":"The leads to delete: one, or a selection"}},"required":["pageId","leadIds"],"additionalProperties":false},"AlphaPageLeadsDeleteResponse":{"type":"object","properties":{"deleted":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"How many of the named leads went"}},"required":["deleted"],"additionalProperties":false},"AlphaAttachmentsDeleteRequest":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"Alpha attachment ID"}},"required":["id"],"additionalProperties":false},"AlphaAttachmentsDeleteResponse":{"type":"object","properties":{"attachmentId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"outcome":{"type":"string","enum":["deleted","delete_pending"]}},"required":["attachmentId","outcome"],"additionalProperties":false},"AlphaAttachmentsReserveUploadRequest":{"type":"object","properties":{"conversationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The member's Alpha conversation ID; a new UUID starts a conversation"},"filename":{"type":"string","minLength":1,"maxLength":255,"description":"The file's name"},"mediaType":{"type":"string","minLength":1,"maxLength":255,"description":"The file's media type: text/plain, text/csv, application/json, text/markdown, text/html, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, image/png, image/jpeg, image/webp, application/pdf"},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":10000000,"description":"The file's exact size in bytes"}},"required":["conversationId","filename","mediaType","byteLength"],"additionalProperties":false,"deprecated":true},"AlphaAttachmentsReserveUploadResponse":{"type":"object","properties":{"attachment":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["text/plain","text/csv","application/json","text/markdown","text/html","application/vnd.openxmlformats-officedocument.wordprocessingml.document","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","image/png","image/jpeg","image/webp","application/pdf"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":10000000}},"required":["id","filename","mediaType","byteLength"],"additionalProperties":false},"upload":{"type":"object","properties":{"method":{"type":"string","const":"PUT"},"url":{"type":"string","format":"uri"},"headers":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"expiresAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["method","url","headers","expiresAt"],"additionalProperties":false,"description":"Send the file as the body of exactly this request before expiresAt. The store answers JSON naming the stored file's etag; pass it to alpha.attachments.complete-upload."},"maxBytes":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"The most bytes this file's format may weigh, which the upload URL enforces"}},"required":["attachment","upload","maxBytes"],"additionalProperties":false},"AlphaAttachmentsReserveUploadV2Request":{"type":"object","properties":{"conversationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The member's Alpha conversation ID; a new UUID starts a conversation"},"filename":{"type":"string","minLength":1,"maxLength":255,"description":"The file's name"},"mediaType":{"type":"string","minLength":1,"maxLength":255,"description":"The file's media type: text/plain, text/csv, application/json, text/markdown, text/html, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/vnd.openxmlformats-officedocument.presentationml.presentation, image/png, image/jpeg, image/webp, application/pdf"},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":10000000,"description":"The file's exact size in bytes"}},"required":["conversationId","filename","mediaType","byteLength"],"additionalProperties":false},"AlphaAttachmentsReserveUploadV2Response":{"type":"object","properties":{"attachment":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["text/plain","text/csv","application/json","text/markdown","text/html","application/vnd.openxmlformats-officedocument.wordprocessingml.document","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","application/vnd.openxmlformats-officedocument.presentationml.presentation","image/png","image/jpeg","image/webp","application/pdf"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":10000000}},"required":["id","filename","mediaType","byteLength"],"additionalProperties":false},"upload":{"type":"object","properties":{"method":{"type":"string","const":"PUT"},"url":{"type":"string","format":"uri"},"headers":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"expiresAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["method","url","headers","expiresAt"],"additionalProperties":false,"description":"Send the file as the body of exactly this request before expiresAt. The store answers JSON naming the stored file's etag; pass it to alpha.attachments.complete-upload."},"maxBytes":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"The most bytes this file's format may weigh, which the upload URL enforces"}},"required":["attachment","upload","maxBytes"],"additionalProperties":false},"AlphaAttachmentsCompleteUploadRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The attachment ID alpha.attachments.reserve-upload returned"},"etag":{"description":"The etag the store answered the PUT with; omit it when that answer was lost","type":"string","minLength":1,"maxLength":1024},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":10000000,"description":"The byte length declared when the upload was reserved"}},"required":["id","byteLength"],"additionalProperties":false,"deprecated":true},"AlphaAttachmentsCompleteUploadResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["text/plain","text/csv","application/json","text/markdown","text/html","application/vnd.openxmlformats-officedocument.wordprocessingml.document","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","image/png","image/jpeg","image/webp","application/pdf"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":10000000}},"required":["id","filename","mediaType","byteLength"],"additionalProperties":false},"AlphaAttachmentsCompleteUploadV2Request":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The attachment ID alpha.attachments.reserve-upload returned"},"etag":{"description":"The etag the store answered the PUT with; omit it when that answer was lost","type":"string","minLength":1,"maxLength":1024},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":10000000,"description":"The byte length declared when the upload was reserved"}},"required":["id","byteLength"],"additionalProperties":false},"AlphaAttachmentsCompleteUploadV2Response":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["text/plain","text/csv","application/json","text/markdown","text/html","application/vnd.openxmlformats-officedocument.wordprocessingml.document","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","application/vnd.openxmlformats-officedocument.presentationml.presentation","image/png","image/jpeg","image/webp","application/pdf"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":10000000}},"required":["id","filename","mediaType","byteLength"],"additionalProperties":false},"AlphaAttachmentsDownloadResponse":{"type":"object","properties":{"filename":{"type":"string","minLength":1,"description":"Suggested file name for saving the bytes"},"contentType":{"type":"string","minLength":1},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Short-lived presigned URL that GETs the bytes; null when this deployment cannot sign the object"},"expiresAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}],"description":"When url stops working (minutes after the call); null with url"},"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"conversationId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The conversation the file belongs to"}},"required":["filename","contentType","byteLength","url","expiresAt","id","conversationId"],"additionalProperties":false},"ResearchCampaignsLaunchRequest":{"type":"object","properties":{"campaignName":{"type":"string","minLength":1,"maxLength":120},"description":{"description":"The study's description, shown under its name on the results; display only, never asked of respondents.","type":"string","maxLength":500},"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The business profile whose customers the study interviews."},"targetKind":{"default":"profile","description":"The profile's own customers (default), or every customer generated for its current store overlays.","type":"string","enum":["profile","physical_locations"]},"targetedGroupIds":{"anyOf":[{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"type":"null"}],"description":"Saved audiences to interview, or null for the whole cohort."},"targetedCustomerIds":{"anyOf":[{"minItems":1,"maxItems":1000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"type":"null"}],"description":"Explicit customers to interview, or null. Never together with saved audiences."},"targetInterviewCount":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"researchFocus":{"type":"string","maxLength":2000,"description":"The study's research focus, screened whole by acceptable use: at most 2,000 characters."},"schedule":{"type":"string","enum":["once","weekly","monthly"]},"questions":{"description":"The whole edited instrument; absent, the study asks its own questions. Acceptable use screens each question's prompt, a task's success criteria and website starting site, and each branch rule's meaning whole, so each is at most 2,000 characters (titles, options and file names are shorter by their own bounds), and the study's screened text is at most 160 KiB; nothing is truncated.","minItems":1,"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/ResearchQuestionsItem"}},"playbookKey":{"type":"string","enum":["ad_copy","brand_health","offers","pricing","product","product_launch","sales","custom","product_roadmap"]},"stimulus":{"$ref":"#/components/schemas/ResearchStimulus"},"kind":{"description":"backtest when the study re-asks a decision the business already made: its situation is the shared material every twin reads first, and its results compare with the outcome recorded on its Overview. Omit it for any other study.","type":"string","const":"backtest"},"assumptions":{"description":"Customer assumptions: statements every respondent answers as true of themselves for this study only, beside their own profile, in order; absent or empty when the study states none. Acceptable use screens each whole, so each is at most 2,000 characters, and none is empty.","maxItems":10,"type":"array","items":{"type":"string","maxLength":10000}},"backtest":{"description":"For a backtest only: its decision mapping (the single-choice question that asks the decision and what each option keeps) and the real-world outcome, recorded at launch. No model ever reads the outcome. Both stay editable on its Overview.","type":"object","properties":{"decision":{"type":"object","properties":{"questionId":{"type":"string","minLength":1,"description":"The single-choice question that asks the decision."},"keeps":{"minItems":1,"maxItems":100,"type":"array","items":{"anyOf":[{"type":"number","minimum":0,"maximum":2},{"type":"null"}]},"description":"By option position: the share of usual buying the answer keeps (0 stops, 1 keeps, up to 2 buys more), or null to leave it out."}},"required":["questionId","keeps"],"additionalProperties":false},"outcome":{"type":"object","properties":{"metric":{"type":"string","minLength":1,"maxLength":120,"description":"What was measured, such as \"Units sold a week\"."},"change":{"type":"number","minimum":-1,"maximum":100,"description":"The measured change, as a fraction: -0.3 is a 30% drop."},"note":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]}},"required":["metric","change"],"additionalProperties":false}},"additionalProperties":false}},"required":["campaignName","businessProfileId","targetedGroupIds","targetedCustomerIds","targetInterviewCount","researchFocus","schedule","playbookKey","stimulus"],"additionalProperties":false},"ResearchCampaignsLaunchResponse":{"type":"object","properties":{"runId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The billing run of the campaign's first interviews."},"entryId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The campaign entry this request started; read its progress with campaigns.campaign-entries.get.v1."},"status":{"type":"string","enum":["workflow_started","encounter_coordination_required"],"description":"How the first run starts."},"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"study":{"type":"string","enum":["ad_copy","brand_health","offers","pricing","product","product_launch","sales","custom","product_roadmap"]}},"required":["runId","entryId","status","campaignId","study"],"additionalProperties":false},"ResearchCampaignSegmentsGetResponse":{"type":"object","properties":{"customers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The segment entry's id, as a segment scope names it."},"label":{"type":"string"}},"required":["id","label"],"additionalProperties":false},"description":"Entries on the `customer` axis: the campaign's customers, by name."},"audiences":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The segment entry's id, as a segment scope names it."},"label":{"type":"string"}},"required":["id","label"],"additionalProperties":false},"description":"Entries on the `audience` axis."},"channels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The segment entry's id, as a segment scope names it."},"label":{"type":"string"}},"required":["id","label"],"additionalProperties":false},"description":"Entries on the `channel` axis."},"stores":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The segment entry's id, as a segment scope names it."},"label":{"type":"string"}},"required":["id","label"],"additionalProperties":false},"description":"Entries on the `store` axis."}},"required":["customers","audiences","channels","stores"],"additionalProperties":false},"ResearchCampaignCustomersListV3Response":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DiscoveryData3"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"totalCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"selectedCustomerIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"audienceTypes":{"type":"array","items":{"type":"string","enum":["b2b","b2c","prosumer","mixed"]},"description":"The audience types of the customers this list draws from, each read as a Buyer type (b2c is B2C; b2b, prosumer and mixed are B2B); a column only another Buyer type carries is not a column."}},"required":["data","nextCursor","totalCount","selectedCustomerIds","audienceTypes"],"additionalProperties":false},"ResearchCampaignCustomersListV4Response":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DiscoveryData4"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"totalCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"selectedCustomerIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"audienceTypes":{"type":"array","items":{"type":"string","enum":["b2b","b2c","prosumer","mixed"]},"description":"The audience types of the customers this list draws from, each read as a Buyer type (b2c is B2C; b2b, prosumer and mixed are B2B); a column only another Buyer type carries is not a column."}},"required":["data","nextCursor","totalCount","selectedCustomerIds","audienceTypes"],"additionalProperties":false},"ResearchCampaignsListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/ResearchCampaignsGetResponse"}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"ResearchCampaignsGetResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"campaignKey":{"type":"string","description":"The campaign's route key."},"name":{"type":"string"},"study":{"type":"string","enum":["ad_copy","brand_health","offers","pricing","product","product_launch","sales","custom","product_roadmap","purchasing","competitors"],"description":"The study the campaign runs."},"status":{"type":"string","enum":["active","paused","archived","deleted"]},"targetKind":{"type":"string","enum":["profile","physical_locations"],"description":"The frozen cohort: the business profile's customers, or its physical stores."},"businessProfileId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"profileName":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The launch profile's display name, else the campaign URL; null without a profile."},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"locationCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"A store campaign's distinct stores among its active members; 0 for a profile campaign."}},"required":["id","campaignKey","name","study","status","targetKind","businessProfileId","profileName","createdAt","locationCount"],"additionalProperties":false},"ResearchCampaignSettingsGetV4Response":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"businessProfileId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The business profile it runs on."},"subtype":{"type":"string","enum":["ad_copy","brand_health","offers","pricing","product","product_launch","sales","custom","product_roadmap","purchasing","competitors"],"description":"The study it runs."},"targetKind":{"type":"string","enum":["profile","physical_locations"],"description":"Whom it interviews: the profile's customers, or its stores' customers."},"targetInterviewCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The interviews each run takes."},"targetedGroupIds":{"anyOf":[{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"type":"null"}],"description":"The audiences it was targeted at; null when not narrowed to audiences."},"targetedCustomerIds":{"anyOf":[{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"type":"null"}],"description":"The customers it was picked from; null when not hand-picked."},"targetedForecastId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The forecast whose customers it interviews; null for current customers."},"competitorSet":{"type":"array","items":{"type":"string"},"description":"The competitors it was set up to compare with."},"instrument":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/ResearchInstrument"},{"$ref":"#/components/schemas/ResearchInstrument2"},{"$ref":"#/components/schemas/ResearchInstrument3"},{"$ref":"#/components/schemas/ResearchInstrument4"},{"type":"object","properties":{"version":{"type":"string","const":"research-campaign-spec.v5"},"playbookKey":{"type":"string","enum":["ad_copy","brand_health","offers","pricing","product","product_launch","sales","custom","product_roadmap"]},"templateSlug":{"type":"string","minLength":1,"maxLength":256},"templateVersion":{"type":"integer","minimum":1,"maximum":9007199254740991},"stimulus":{"$ref":"#/components/schemas/ResearchStimulus2"},"questions":{"$ref":"#/components/schemas/ResearchQuestions"},"resultContract":{"type":"object","properties":{"version":{"type":"string","const":"research-result-contract.v1"},"observationKinds":{"minItems":1,"maxItems":6,"type":"array","items":{"type":"string","enum":["choice","rating","ranking","open_text","task_outcome","conversation_rubric"]}}},"required":["version","observationKinds"],"additionalProperties":false},"scorer":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[a-z][a-z0-9._-]*$"},"version":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["id","version"],"additionalProperties":false},"presentationOrder":{"type":"string","const":"per_participant"},"assumptions":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"string","minLength":1,"maxLength":2000}}},"required":["version","playbookKey","templateSlug","templateVersion","stimulus","questions","resultContract","scorer","assumptions"],"additionalProperties":false}]},{"$ref":"#/components/schemas/ResearchInstrument5"}],"description":"The study as saved: its questions and, for a study that shows something, what it shows. A study saved before the campaign spec carries its questions alone."},"settingsRevision":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Its settings revision: pass it as expectedSettingsRevision to research.campaign-settings-quotes.get and research.campaign-settings.update."},"locks":{"type":"object","properties":{"targetInterviewCount":{"type":"string"},"audience":{"type":"string"},"frequency":{"type":"string"},"study":{"type":"string"}},"additionalProperties":false,"description":"The settings research.campaign-settings.update cannot change on this campaign, each with why; a setting absent here changes."}},"required":["id","businessProfileId","subtype","targetKind","targetInterviewCount","targetedGroupIds","targetedCustomerIds","targetedForecastId","competitorSet","instrument","settingsRevision","locks"],"additionalProperties":false},"ResearchCampaignSettingsGetV3Response":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"businessProfileId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The business profile it runs on."},"subtype":{"type":"string","enum":["ad_copy","brand_health","offers","pricing","product","product_launch","sales","custom","product_roadmap","purchasing","competitors"],"description":"The study it runs."},"targetKind":{"type":"string","enum":["profile","physical_locations"],"description":"Whom it interviews: the profile's customers, or its stores' customers."},"targetInterviewCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The interviews each run takes."},"targetedGroupIds":{"anyOf":[{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"type":"null"}],"description":"The audiences it was targeted at; null when not narrowed to audiences."},"targetedCustomerIds":{"anyOf":[{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"type":"null"}],"description":"The customers it was picked from; null when not hand-picked."},"targetedForecastId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The forecast whose customers it interviews; null for current customers."},"competitorSet":{"type":"array","items":{"type":"string"},"description":"The competitors it was set up to compare with."},"instrument":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/ResearchInstrument"},{"$ref":"#/components/schemas/ResearchInstrument2"},{"$ref":"#/components/schemas/ResearchInstrument3"},{"$ref":"#/components/schemas/ResearchInstrument4"}]},{"$ref":"#/components/schemas/ResearchInstrument5"}],"description":"The study as saved: its questions and, for a study that shows something, what it shows. A study saved before the campaign spec carries its questions alone."},"settingsRevision":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Its settings revision: pass it as expectedSettingsRevision to research.campaign-settings-quotes.get and research.campaign-settings.update."},"locks":{"type":"object","properties":{"targetInterviewCount":{"type":"string"},"audience":{"type":"string"},"frequency":{"type":"string"},"study":{"type":"string"}},"additionalProperties":false,"description":"The settings research.campaign-settings.update cannot change on this campaign, each with why; a setting absent here changes."}},"required":["id","businessProfileId","subtype","targetKind","targetInterviewCount","targetedGroupIds","targetedCustomerIds","targetedForecastId","competitorSet","instrument","settingsRevision","locks"],"additionalProperties":false},"ResearchCampaignSettingsGetV2Response":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"businessProfileId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The business profile it runs on."},"subtype":{"type":"string","enum":["ad_copy","brand_health","offers","pricing","product","product_launch","sales","custom","product_roadmap","purchasing","competitors"],"description":"The study it runs."},"targetKind":{"type":"string","enum":["profile","physical_locations"],"description":"Whom it interviews: the profile's customers, or its stores' customers."},"targetInterviewCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The interviews each run takes."},"targetedGroupIds":{"anyOf":[{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"type":"null"}],"description":"The audiences it was targeted at; null when not narrowed to audiences."},"targetedCustomerIds":{"anyOf":[{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"type":"null"}],"description":"The customers it was picked from; null when not hand-picked."},"targetedForecastId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The forecast whose customers it interviews; null for current customers."},"competitorSet":{"type":"array","items":{"type":"string"},"description":"The competitors it was set up to compare with."},"instrument":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/ResearchInstrument"},{"$ref":"#/components/schemas/ResearchInstrument2"},{"$ref":"#/components/schemas/ResearchInstrument3"},{"type":"object","properties":{"version":{"type":"string","const":"research-campaign-spec.v4"},"playbookKey":{"type":"string","enum":["ad_copy","brand_health","offers","pricing","product","product_launch","sales","custom","product_roadmap"]},"templateSlug":{"type":"string","minLength":1,"maxLength":256},"templateVersion":{"type":"integer","minimum":1,"maximum":9007199254740991},"stimulus":{"$ref":"#/components/schemas/ResearchStimulus2"},"questions":{"minItems":1,"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/ResearchInstrumentQuestionsItem"}},"resultContract":{"type":"object","properties":{"version":{"type":"string","const":"research-result-contract.v1"},"observationKinds":{"minItems":1,"maxItems":6,"type":"array","items":{"type":"string","enum":["choice","rating","ranking","open_text","task_outcome","conversation_rubric"]}}},"required":["version","observationKinds"],"additionalProperties":false},"scorer":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[a-z][a-z0-9._-]*$"},"version":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["id","version"],"additionalProperties":false},"presentationOrder":{"type":"string","const":"per_participant"}},"required":["version","playbookKey","templateSlug","templateVersion","stimulus","questions","resultContract","scorer"],"additionalProperties":false}]},{"$ref":"#/components/schemas/ResearchInstrument5"}],"description":"The study as saved: its questions and, for a study that shows something, what it shows. A study saved before the campaign spec carries its questions alone."},"settingsRevision":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Its settings revision: pass it as expectedSettingsRevision to research.campaign-settings-quotes.get and research.campaign-settings.update."},"locks":{"type":"object","properties":{"targetInterviewCount":{"type":"string"},"audience":{"type":"string"},"frequency":{"type":"string"},"study":{"type":"string"}},"additionalProperties":false,"description":"The settings research.campaign-settings.update cannot change on this campaign, each with why; a setting absent here changes."}},"required":["id","businessProfileId","subtype","targetKind","targetInterviewCount","targetedGroupIds","targetedCustomerIds","targetedForecastId","competitorSet","instrument","settingsRevision","locks"],"additionalProperties":false},"ResearchCampaignSettingsGetResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"businessProfileId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The business profile it runs on."},"subtype":{"type":"string","enum":["ad_copy","brand_health","offers","pricing","product","product_launch","sales","custom","product_roadmap","purchasing","competitors"],"description":"The study it runs."},"targetKind":{"type":"string","enum":["profile","physical_locations"],"description":"Whom it interviews: the profile's customers, or its stores' customers."},"targetInterviewCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The interviews each run takes."},"targetedGroupIds":{"anyOf":[{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"type":"null"}],"description":"The audiences it was targeted at; null when not narrowed to audiences."},"targetedCustomerIds":{"anyOf":[{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"type":"null"}],"description":"The customers it was picked from; null when not hand-picked."},"targetedForecastId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The forecast whose customers it interviews; null for current customers."},"competitorSet":{"type":"array","items":{"type":"string"},"description":"The competitors it was set up to compare with."},"instrument":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/ResearchInstrument"},{"$ref":"#/components/schemas/ResearchInstrument2"},{"$ref":"#/components/schemas/ResearchInstrument3"},{"type":"object","properties":{"version":{"type":"string","const":"research-campaign-spec.v4"},"playbookKey":{"type":"string","enum":["ad_copy","brand_health","offers","pricing","product","product_launch","sales","custom","product_roadmap"]},"templateSlug":{"type":"string","minLength":1,"maxLength":256},"templateVersion":{"type":"integer","minimum":1,"maximum":9007199254740991},"stimulus":{"$ref":"#/components/schemas/ResearchStimulus2"},"questions":{"minItems":1,"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/ResearchInstrumentQuestionsItem2"}},"resultContract":{"type":"object","properties":{"version":{"type":"string","const":"research-result-contract.v1"},"observationKinds":{"minItems":1,"maxItems":6,"type":"array","items":{"type":"string","enum":["choice","rating","ranking","open_text","task_outcome","conversation_rubric"]}}},"required":["version","observationKinds"],"additionalProperties":false},"scorer":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[a-z][a-z0-9._-]*$"},"version":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["id","version"],"additionalProperties":false},"presentationOrder":{"type":"string","const":"per_participant"}},"required":["version","playbookKey","templateSlug","templateVersion","stimulus","questions","resultContract","scorer"],"additionalProperties":false}]},{"$ref":"#/components/schemas/ResearchInstrument5"}],"description":"The study as saved: its questions and, for a study that shows something, what it shows. A study saved before the campaign spec carries its questions alone."},"settingsRevision":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Its settings revision: pass it as expectedSettingsRevision to research.campaign-settings-quotes.get and research.campaign-settings.update."},"locks":{"type":"object","properties":{"targetInterviewCount":{"type":"string"},"audience":{"type":"string"},"frequency":{"type":"string"},"study":{"type":"string"}},"additionalProperties":false,"description":"The settings research.campaign-settings.update cannot change on this campaign, each with why; a setting absent here changes."}},"required":["id","businessProfileId","subtype","targetKind","targetInterviewCount","targetedGroupIds","targetedCustomerIds","targetedForecastId","competitorSet","instrument","settingsRevision","locks"],"additionalProperties":false},"ResearchCampaignSettingsQuotesGetResponse":{"type":"object","properties":{"settingsRevision":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The settings revision this quote read; pass it as expectedSettingsRevision."},"requiresReview":{"type":"boolean","description":"Whether the Save changes money or results, so Billing is asked about its work and a quoted estimate is re-checked; false when it changes only the name."},"changes":{"$ref":"#/components/schemas/DiscoveryChanges"},"estimate":{"$ref":"#/components/schemas/DiscoveryEstimate"},"billing":{"oneOf":[{"type":"object","properties":{"outcome":{"type":"string","const":"not_needed"}},"required":["outcome"],"additionalProperties":false},{"type":"object","properties":{"outcome":{"type":"string","const":"admitted"}},"required":["outcome"],"additionalProperties":false},{"type":"object","properties":{"outcome":{"type":"string","const":"refused"},"reason":{"type":"string","minLength":1,"description":"Billing's refusal reason."},"message":{"type":"string","minLength":1,"description":"Billing's refusal, in its own words."},"paymentDisputeHold":{"type":"boolean","description":"Whether the account is held for a payment dispute, which a new card does not lift."}},"required":["outcome","reason","message","paymentDisputeHold"],"additionalProperties":false}]},"resultsNote":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How the change reaches results; null when results do not change."},"reviewedEstimate":{"anyOf":[{"type":"object","properties":{"monthlyAfter":{"type":"integer","minimum":0,"maximum":9007199254740991},"unitPriceCents":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"oneTimeAmountCents":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]}},"required":["monthlyAfter","unitPriceCents","oneTimeAmountCents"],"additionalProperties":false,"description":"The estimate a quote returned (its reviewedEstimate): the Save is refused if it moved. Null saves at the current estimate."},{"type":"null"}],"description":"Pass to the update as reviewedEstimate; null when there is no estimate."},"customersLeaving":{"type":"array","items":{"type":"object","properties":{"customerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"joinedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["customerId","name","joinedAt"],"additionalProperties":false},"description":"Who a lower count removes: the newest joined first."}},"required":["settingsRevision","requiresReview","changes","estimate","billing","resultsNote","reviewedEstimate","customersLeaving"],"additionalProperties":false},"ResearchCampaignSettingsStudy":{"type":"object","properties":{"stimulus":{"type":"object","properties":{"version":{"type":"string","const":"research-stimulus.v1"},"kind":{"type":"string","const":"custom"},"title":{"type":"string","minLength":1,"maxLength":500},"content":{"type":"string","minLength":1,"maxLength":10000},"assetRefs":{"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":512}},"private":{"type":"boolean","const":true}},"required":["version","kind","content"],"additionalProperties":false,"description":"The study's material, in its author's words."},"questions":{"minItems":1,"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/ResearchQuestionsItem"},"description":"The whole edited instrument."},"assumptions":{"description":"The study's customer assumptions, in order, each screened whole as a launch screens them. Absent keeps the ones the study states; empty removes them.","maxItems":10,"type":"array","items":{"type":"string","maxLength":10000}}},"required":["stimulus","questions"],"additionalProperties":false,"description":"The study as it runs from the next admission day; results count an edited question's answers from its edit, and every unchanged question keeps its history."},"ResearchCampaignSettingsUpdateRequest":{"type":"object","properties":{"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The campaign's id."},"expectedSettingsRevision":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The settingsRevision the settings read (or a quote) returned."},"reviewedEstimate":{"anyOf":[{"type":"object","properties":{"monthlyAfter":{"type":"integer","minimum":0,"maximum":9007199254740991},"unitPriceCents":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"oneTimeAmountCents":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]}},"required":["monthlyAfter","unitPriceCents","oneTimeAmountCents"],"additionalProperties":false,"description":"The estimate a quote returned (its reviewedEstimate): the Save is refused if it moved. Null saves at the current estimate."},{"type":"null"}]},"changes":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120,"description":"The campaign's new name."},"targetInterviewCount":{"description":"Interviews each period takes, one per customer: raising it adds the next eligible customers in the study's own sampling order, lowering it removes the newest joined first (named in the quote's customersLeaving) and cancels their interviews not yet started.","type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"audience":{"description":"Whom customers added later are drawn from: every eligible customer (all) or members of targetedGroupIds (groups). The current customers stay.","type":"string","enum":["all","groups"]},"targetedGroupIds":{"description":"The audiences, with audience groups.","minItems":1,"maxItems":20,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"frequency":{"description":"The period a repeating study interviews each customer once in; a new period starts at the next admission day.","type":"string","enum":["weekly","monthly"]},"study":{"$ref":"#/components/schemas/ResearchCampaignSettingsStudy"}},"additionalProperties":false}},"required":["campaignId","expectedSettingsRevision","reviewedEstimate","changes"],"additionalProperties":false},"ResearchCampaignSettingsUpdateResponse":{"type":"object","properties":{"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"changed":{"type":"boolean","description":"False when the Save asked for the settings the campaign has."},"settingsRevision":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The campaign's revision now."},"changes":{"$ref":"#/components/schemas/DiscoveryChanges2"}},"required":["campaignId","changed","settingsRevision","changes"],"additionalProperties":false},"ResearchConversationsListV2Response":{"type":"object","properties":{"data":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"respondent":{"type":"string"},"study":{"type":"string","enum":["ad_copy","brand_health","offers","pricing","product","product_launch","sales","custom","product_roadmap","purchasing","competitors"],"description":"The Research study type the campaign runs."},"campaignName":{"type":"string"},"questionCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"status":{"anyOf":[{"type":"string","enum":["scheduled","waiting","running","completed","failed","cancelled"]},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]}},"required":["id","respondent","study","campaignName","questionCount","status","completedAt"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"totalCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"segments":{"description":"The segments the list was read under, when the request named any; an entry is labeled only on a first page (no cursor) with a campaignId.","maxItems":50,"type":"array","items":{"type":"object","properties":{"axis":{"type":"string","enum":["audience","channel","market","age","householdIncome","education","lifeStage","areaType","companySize","buyerRole","seniority","occupation","job","triggerType","intentStage","language","gender","store","customer"]},"id":{"type":"string","minLength":1,"maxLength":512},"label":{"description":"The entry's name as research.campaign-segments.get.v1 lists it (audience, channel and store entries only); absent for any other axis or for a member the campaign's active roster does not hold.","type":"string"}},"required":["axis","id"],"additionalProperties":false}}},"required":["data","nextCursor","totalCount"],"additionalProperties":false},"ResearchConversationsGetV3Response":{"type":"object","properties":{"transcript":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"respondent":{"type":"string"},"study":{"type":"string","enum":["ad_copy","brand_health","offers","pricing","product","product_launch","sales","custom","product_roadmap","purchasing","competitors"],"description":"The Research study type the campaign runs."},"campaignName":{"type":"string"},"status":{"anyOf":[{"type":"string","enum":["scheduled","waiting","running","completed","failed","cancelled"]},{"type":"null"}]},"modelId":{"type":"string"},"completedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"turns":{"type":"array","items":{"type":"object","properties":{"questionId":{"type":"string"},"title":{"type":"string"},"prompt":{"type":"string"},"answer":{"type":"string"},"attachment":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm","audio/mpeg","audio/wav"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":104857600}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false}},"required":["questionId","title","prompt","answer"],"additionalProperties":false}},"customerVersionId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The respondent's exact customer version; null when history cannot claim one."}},"required":["id","campaignId","respondent","study","campaignName","status","modelId","completedAt","createdAt","turns","customerVersionId"],"additionalProperties":false},"computerResults":{"$ref":"#/components/schemas/ResearchComputerResults"}},"required":["transcript","computerResults"],"additionalProperties":false},"ResearchConversationsGetV2Response":{"type":"object","properties":{"transcript":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"respondent":{"type":"string"},"study":{"type":"string","enum":["ad_copy","brand_health","offers","pricing","product","product_launch","sales","custom","product_roadmap","purchasing","competitors"],"description":"The Research study type the campaign runs."},"campaignName":{"type":"string"},"status":{"anyOf":[{"type":"string","enum":["scheduled","waiting","running","completed","failed","cancelled"]},{"type":"null"}]},"modelId":{"type":"string"},"completedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"turns":{"type":"array","items":{"type":"object","properties":{"questionId":{"type":"string"},"title":{"type":"string"},"prompt":{"type":"string"},"answer":{"type":"string"},"attachment":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":104857600}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false}},"required":["questionId","title","prompt","answer"],"additionalProperties":false}},"customerVersionId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The respondent's exact customer version; null when history cannot claim one."}},"required":["id","campaignId","respondent","study","campaignName","status","modelId","completedAt","createdAt","turns","customerVersionId"],"additionalProperties":false},"computerResults":{"$ref":"#/components/schemas/ResearchComputerResults"}},"required":["transcript","computerResults"],"additionalProperties":false},"ResearchConversationsGetResponse":{"type":"object","properties":{"transcript":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"respondent":{"type":"string"},"study":{"type":"string","enum":["ad_copy","brand_health","offers","pricing","product","product_launch","sales","custom","product_roadmap","purchasing","competitors"],"description":"The Research study type the campaign runs."},"campaignName":{"type":"string"},"status":{"anyOf":[{"type":"string","enum":["scheduled","waiting","running","completed","failed","cancelled"]},{"type":"null"}]},"modelId":{"type":"string"},"completedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"turns":{"type":"array","items":{"type":"object","properties":{"questionId":{"type":"string"},"title":{"type":"string"},"prompt":{"type":"string"},"answer":{"type":"string"},"attachment":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":4194304}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false}},"required":["questionId","title","prompt","answer"],"additionalProperties":false}},"customerVersionId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The respondent's exact customer version; null when history cannot claim one."}},"required":["id","campaignId","respondent","study","campaignName","status","modelId","completedAt","createdAt","turns","customerVersionId"],"additionalProperties":false},"computerResults":{"$ref":"#/components/schemas/ResearchComputerResults"}},"required":["transcript","computerResults"],"additionalProperties":false},"ResearchStudyDraftDocumentV3":{"type":"object","properties":{"version":{"type":"string","const":"research-study-draft.v1"},"kind":{"type":"string","const":"backtest"},"playbookKey":{"anyOf":[{"type":"string","enum":["ad_copy","brand_health","offers","pricing","product","product_launch","sales","custom","product_roadmap"]},{"type":"null"}]},"campaignName":{"type":"string","maxLength":120},"display":{"type":"object","properties":{"description":{"type":"string","maxLength":500},"endLabel":{"type":"string","maxLength":500},"branchLabels":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":128},"additionalProperties":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":128},"additionalProperties":{"type":"string","maxLength":500}}}},"additionalProperties":false},"designer":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","enum":["user","assistant"]},"content":{"type":"string","minLength":1,"maxLength":32000}},"required":["role","content"],"additionalProperties":false}},"attachments":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm","audio/mpeg","audio/wav"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":104857600}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false}},"brief":{"type":"string","maxLength":32000},"reply":{"type":"string","maxLength":32000},"reviewedBrief":{"type":"string","maxLength":32000},"reviewedAttachments":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm","audio/mpeg","audio/wav"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":104857600}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false}},"deliveredQuestionDigests":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":128},"additionalProperties":{"type":"string","minLength":64,"maxLength":64}},"pending":{"$ref":"#/components/schemas/ResearchPending"},"proposal":{"type":"object","properties":{"turn":{"$ref":"#/components/schemas/ResearchPending"},"design":{"$ref":"#/components/schemas/ResearchProposalDesign"}},"required":["turn","design"],"additionalProperties":false}},"required":["messages","attachments"],"additionalProperties":false},"profileId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"string","const":""}]},"contentLanguage":{"type":"string","enum":["en","fr","es","de","pt","ja","it","nl","sv","cs","pl","tr","ru","zh-Hans","ko","ar"]},"material":{"$ref":"#/components/schemas/ResearchMaterial"},"stimulus":{"$ref":"#/components/schemas/ResearchStimulus3"},"researchFocus":{"type":"string","maxLength":2000},"schedule":{"type":"string","enum":["once","weekly","monthly"]},"questions":{"anyOf":[{"$ref":"#/components/schemas/ResearchQuestions2"},{"type":"null"}]},"assumptions":{"maxItems":10,"type":"array","items":{"type":"string","maxLength":10000},"description":"Customer assumptions: statements every respondent answers as true of themselves for this study only, beside their own profile, in order. Empty when the study states none."},"backtest":{"$ref":"#/components/schemas/ResearchBacktest"},"targetedGroupIds":{"anyOf":[{"maxItems":20,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"type":"null"}]},"targetedCustomerIds":{"anyOf":[{"maxItems":1000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"type":"null"}]}},"required":["version","playbookKey","campaignName","profileId","material","researchFocus","schedule","questions","targetedGroupIds","targetedCustomerIds"],"additionalProperties":false},"ResearchDraftsGetV3Response":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revision":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Compare-and-swap revision a later save must name."},"document":{"$ref":"#/components/schemas/ResearchStudyDraftDocumentV3"}},"required":["id","revision","document"],"additionalProperties":false},"ResearchStudyDraftDocumentV2":{"type":"object","properties":{"version":{"type":"string","const":"research-study-draft.v1"},"kind":{"type":"string","const":"backtest"},"playbookKey":{"anyOf":[{"type":"string","enum":["ad_copy","brand_health","offers","pricing","product","product_launch","sales","custom","product_roadmap"]},{"type":"null"}]},"campaignName":{"type":"string","maxLength":120},"display":{"type":"object","properties":{"description":{"type":"string","maxLength":500},"endLabel":{"type":"string","maxLength":500},"branchLabels":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":128},"additionalProperties":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":128},"additionalProperties":{"type":"string","maxLength":500}}}},"additionalProperties":false},"designer":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","enum":["user","assistant"]},"content":{"type":"string","minLength":1,"maxLength":32000}},"required":["role","content"],"additionalProperties":false}},"attachments":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":104857600}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false}},"brief":{"type":"string","maxLength":32000},"reply":{"type":"string","maxLength":32000},"reviewedBrief":{"type":"string","maxLength":32000},"reviewedAttachments":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":104857600}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false}},"deliveredQuestionDigests":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":128},"additionalProperties":{"type":"string","minLength":64,"maxLength":64}},"pending":{"$ref":"#/components/schemas/ResearchDesignerPending"},"proposal":{"type":"object","properties":{"turn":{"$ref":"#/components/schemas/ResearchDesignerPending"},"design":{"$ref":"#/components/schemas/ResearchDesignerProposalDesign"}},"required":["turn","design"],"additionalProperties":false}},"required":["messages","attachments"],"additionalProperties":false},"profileId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"string","const":""}]},"contentLanguage":{"type":"string","enum":["en","fr","es","de","pt","ja","it","nl","sv","cs","pl","tr","ru","zh-Hans","ko","ar"]},"material":{"$ref":"#/components/schemas/ResearchMaterial2"},"stimulus":{"$ref":"#/components/schemas/ResearchStimulus3"},"researchFocus":{"type":"string","maxLength":2000},"schedule":{"type":"string","enum":["once","weekly","monthly"]},"questions":{"anyOf":[{"$ref":"#/components/schemas/ResearchQuestions3"},{"type":"null"}]},"assumptions":{"maxItems":10,"type":"array","items":{"type":"string","maxLength":10000},"description":"Customer assumptions: statements every respondent answers as true of themselves for this study only, beside their own profile, in order. Empty when the study states none."},"backtest":{"$ref":"#/components/schemas/ResearchBacktest"},"targetedGroupIds":{"anyOf":[{"maxItems":20,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"type":"null"}]},"targetedCustomerIds":{"anyOf":[{"maxItems":1000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"type":"null"}]}},"required":["version","playbookKey","campaignName","profileId","material","researchFocus","schedule","questions","targetedGroupIds","targetedCustomerIds"],"additionalProperties":false},"ResearchDraftsGetV2Response":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revision":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Compare-and-swap revision a later save must name."},"document":{"$ref":"#/components/schemas/ResearchStudyDraftDocumentV2"}},"required":["id","revision","document"],"additionalProperties":false},"ResearchStudyDraftDocument":{"type":"object","properties":{"version":{"type":"string","const":"research-study-draft.v1"},"kind":{"type":"string","const":"backtest"},"playbookKey":{"anyOf":[{"type":"string","enum":["ad_copy","brand_health","offers","pricing","product","product_launch","sales","custom","product_roadmap"]},{"type":"null"}]},"campaignName":{"type":"string","maxLength":120},"display":{"type":"object","properties":{"description":{"type":"string","maxLength":500},"endLabel":{"type":"string","maxLength":500},"branchLabels":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":128},"additionalProperties":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":128},"additionalProperties":{"type":"string","maxLength":500}}}},"additionalProperties":false},"designer":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","enum":["user","assistant"]},"content":{"type":"string","minLength":1,"maxLength":32000}},"required":["role","content"],"additionalProperties":false}},"attachments":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":4194304}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false}},"brief":{"type":"string","maxLength":32000},"reply":{"type":"string","maxLength":32000},"reviewedBrief":{"type":"string","maxLength":32000},"reviewedAttachments":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":4194304}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false}},"deliveredQuestionDigests":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":128},"additionalProperties":{"type":"string","minLength":64,"maxLength":64}},"pending":{"$ref":"#/components/schemas/ResearchDesignerPending2"},"proposal":{"type":"object","properties":{"turn":{"$ref":"#/components/schemas/ResearchDesignerPending2"},"design":{"$ref":"#/components/schemas/ResearchDesignerProposalDesign2"}},"required":["turn","design"],"additionalProperties":false}},"required":["messages","attachments"],"additionalProperties":false},"profileId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"string","const":""}]},"contentLanguage":{"type":"string","enum":["en","fr","es","de","pt","ja","it","nl","sv","cs","pl","tr","ru","zh-Hans","ko","ar"]},"material":{"$ref":"#/components/schemas/ResearchMaterial3"},"stimulus":{"$ref":"#/components/schemas/ResearchStimulus3"},"researchFocus":{"type":"string","maxLength":2000},"schedule":{"type":"string","enum":["once","weekly","monthly"]},"questions":{"anyOf":[{"$ref":"#/components/schemas/ResearchQuestions4"},{"type":"null"}]},"assumptions":{"maxItems":10,"type":"array","items":{"type":"string","maxLength":10000},"description":"Customer assumptions: statements every respondent answers as true of themselves for this study only, beside their own profile, in order. Empty when the study states none."},"backtest":{"$ref":"#/components/schemas/ResearchBacktest"},"targetedGroupIds":{"anyOf":[{"maxItems":20,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"type":"null"}]},"targetedCustomerIds":{"anyOf":[{"maxItems":1000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"type":"null"}]}},"required":["version","playbookKey","campaignName","profileId","material","researchFocus","schedule","questions","targetedGroupIds","targetedCustomerIds"],"additionalProperties":false},"ResearchDraftsGetResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revision":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Compare-and-swap revision a later save must name."},"document":{"$ref":"#/components/schemas/ResearchStudyDraftDocument"}},"required":["id","revision","document"],"additionalProperties":false},"ResearchDraftsSaveV3Request":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The study draft id; the client mints it for a new draft."},"revision":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The revision this edit was read at, or 0 to create the draft."},"document":{"$ref":"#/components/schemas/ResearchStudyDraftDocumentV3"}},"required":["id","revision","document"],"additionalProperties":false},"ResearchDraftsSaveV3Response":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revision":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Compare-and-swap revision a later save must name."},"document":{"$ref":"#/components/schemas/ResearchStudyDraftDocumentV3"}},"required":["id","revision","document"],"additionalProperties":false},"ResearchDraftsSaveV2Request":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The study draft id; the client mints it for a new draft."},"revision":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The revision this edit was read at, or 0 to create the draft."},"document":{"$ref":"#/components/schemas/ResearchStudyDraftDocumentV2"}},"required":["id","revision","document"],"additionalProperties":false,"deprecated":true},"ResearchDraftsSaveV2Response":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revision":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Compare-and-swap revision a later save must name."},"document":{"$ref":"#/components/schemas/ResearchStudyDraftDocumentV2"}},"required":["id","revision","document"],"additionalProperties":false},"ResearchDraftsSaveRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The study draft id; the client mints it for a new draft."},"revision":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The revision this edit was read at, or 0 to create the draft."},"document":{"$ref":"#/components/schemas/ResearchStudyDraftDocument"}},"required":["id","revision","document"],"additionalProperties":false,"deprecated":true},"ResearchDraftsSaveResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revision":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Compare-and-swap revision a later save must name."},"document":{"$ref":"#/components/schemas/ResearchStudyDraftDocument"}},"required":["id","revision","document"],"additionalProperties":false},"ResearchDraftsDeleteRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The study draft id."},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"The revision you last read; a draft saved since then is not deleted."}},"required":["id","revision"],"additionalProperties":false},"ResearchDraftsDeleteResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"deleted":{"type":"boolean","const":true}},"required":["id","deleted"],"additionalProperties":false},"ResearchDraftsCopyV2Request":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The new draft's id; the client mints it."},"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The Research campaign whose saved study is copied."}},"required":["id","campaignId"],"additionalProperties":false},"ResearchDraftsCopyV2Response":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revision":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Compare-and-swap revision a later save must name."},"document":{"$ref":"#/components/schemas/ResearchStudyDraftDocumentV3"}},"required":["id","revision","document"],"additionalProperties":false},"ResearchDraftsCopyRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The new draft's id; the client mints it."},"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The Research campaign whose saved study is copied."}},"required":["id","campaignId"],"additionalProperties":false,"deprecated":true},"ResearchDraftsCopyResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revision":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Compare-and-swap revision a later save must name."},"document":{"$ref":"#/components/schemas/ResearchStudyDraftDocumentV2"}},"required":["id","revision","document"],"additionalProperties":false},"ResearchResultsGetV7Response":{"type":"object","properties":{"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"study":{"type":"string","enum":["ad_copy","brand_health","offers","pricing","product","product_launch","sales","custom","product_roadmap","purchasing","competitors"]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The study's description as its author wrote it under the name in the study editor; null when it has none, as on every study launched before launch kept it."},"assumptions":{"type":"array","items":{"type":"string"},"description":"The customer assumptions every answer assumes: statements each respondent took as true of themselves for this study only, beside their own profile, in order. A saved run (runId) answers the ones it froze: the study's, and any a backtest's rerun added. Empty when the study states none."},"onCalendar":{"type":"boolean","description":"The study runs weekly or monthly, so a settings Save changes it from its next admission day; false for a study that runs once."},"runId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The run whose status, coverage and synthesized titles, summaries and quotes the results show: the saved run named, else the newest run with an interview in the date range; null before any run."},"runDay":{"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}],"description":"The UTC day the run started; null before any run."},"runStatus":{"anyOf":[{"type":"string","enum":["running","succeeded","failed","cancelled","partial"]},{"type":"null"}]},"runDelayed":{"type":"boolean","description":"The running run is past its phase's maximum wait with no terminal receipt."},"analysisRerunnable":{"type":"boolean","description":"The run failed after its interviews were analyzed; research.runs.reanalyze.v1 re-runs its analysis at no interview charge."},"coverage":{"anyOf":[{"type":"object","properties":{"requested":{"type":"integer","minimum":0,"maximum":9007199254740991},"reserved":{"type":"integer","minimum":0,"maximum":9007199254740991},"attempted":{"type":"integer","minimum":0,"maximum":9007199254740991},"completed":{"type":"integer","minimum":0,"maximum":9007199254740991},"extracted":{"type":"integer","minimum":0,"maximum":9007199254740991},"failed":{"type":"integer","minimum":0,"maximum":9007199254740991},"unresolved":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["requested","reserved","attempted","completed","extracted","failed","unresolved"],"additionalProperties":false},{"type":"null"}],"description":"The run's interviews owed and delivered; null before any run."},"entry":{"$ref":"#/components/schemas/ResearchEntry"},"range":{"$ref":"#/components/schemas/ResearchRange"},"interactionDays":{"anyOf":[{"type":"object","properties":{"first":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"The UTC day of the campaign's first interview."},"last":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"The UTC day of its last."}},"required":["first","last"],"additionalProperties":false},{"type":"null"}],"description":"The days of the campaign's first and last interviews, whatever the range; null before its first and on a saved run's results. With a null range, the range holds neither nor any between them."},"widenedToAllTime":{"type":"boolean","description":"A dateRange with widenWhenEmpty held no interview, so the figures read All time."},"rows":{"$ref":"#/components/schemas/ResearchRows"},"scorecard":{"$ref":"#/components/schemas/ResearchScorecard"},"segments":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"axis":{"type":"string","enum":["audience","channel","market","age","householdIncome","education","lifeStage","areaType","companySize","buyerRole","seniority","occupation","job","triggerType","intentStage","language","gender","store","customer"]},"id":{"type":"string","minLength":1,"maxLength":512},"label":{"description":"The entry's name as research.campaign-segments.get.v1 lists it (audience, channel and store entries only); absent for any other axis or for a member the campaign's active roster does not hold.","type":"string"}},"required":["axis","id"],"additionalProperties":false},"description":"The scope the figures were read under."},"creativeScorecard":{"anyOf":[{"type":"object","properties":{"status":{"type":"string","enum":["standing","measures_changed","not_rated"],"description":"standing: the measures stand over the study and someone rated; not_rated: nobody rated yet; measures_changed: a settings Save moved the questions the measures name, so only what the test froze is stated, with no figure."},"scale":{"anyOf":[{"type":"object","properties":{"points":{"type":"integer","minimum":2,"maximum":9007199254740991},"min":{"type":"number","description":"The value the scale's lowest point was read as."},"max":{"type":"number","description":"The value its highest point was read as."},"labels":{"type":"array","items":{"type":"string"},"description":"Each point's option, lowest first."}},"required":["points","min","max","labels"],"additionalProperties":false},{"type":"null"}],"description":"The one scale every measure rates on; null once the measures changed."},"metrics":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","enum":["stopping_power","clarity","relevance","appeal","believability","distinctiveness","brand_clarity","platform_fit","intent_to_act"]},"label":{"type":"string"}},"required":["key","label"],"additionalProperties":false},"description":"The metrics the test named, in setup's order."},"creatives":{"type":"array","items":{"type":"object","properties":{"artifactId":{"type":"string"},"label":{"type":"string","description":"The name its file was shown under; a second file of one name reads `name (2)`."},"position":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Its place in the order the study first rates them."}},"required":["artifactId","label","position"],"additionalProperties":false},"description":"Every tested creative, keyed by its attachment's artifactId."},"measures":{"type":"array","items":{"type":"object","properties":{"metric":{"type":"string","enum":["stopping_power","clarity","relevance","appeal","believability","distinctiveness","brand_clarity","platform_fit","intent_to_act"],"description":"The metric the question rates."},"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The rated creative: its attachment's artifactId."},"questionId":{"type":"string","minLength":1,"description":"The scale question that asks it."}},"required":["metric","artifactId","questionId"],"additionalProperties":false},"description":"The question rating each metric of each creative, as the test froze them."},"cells":{"type":"array","items":{"type":"object","properties":{"metric":{"type":"string","enum":["stopping_power","clarity","relevance","appeal","believability","distinctiveness","brand_clarity","platform_fit","intent_to_act"]},"artifactId":{"type":"string"},"questionId":{"type":"string"},"n":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The ratings counted."},"customers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct respondents behind the figure."},"mean":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Unrounded, on the scale's values; null when nobody rated."},"sd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The sample standard deviation; null for fewer than two values."},"interval":{"anyOf":[{"type":"object","properties":{"low":{"type":"number"},"high":{"type":"number"}},"required":["low","high"],"additionalProperties":false,"description":"The 95% interval: the mean ± 1.96 standard errors, on the scale's values."},{"type":"null"}],"description":"Null for fewer than two values."},"precision":{"$ref":"#/components/schemas/ResearchPrecision"},"distribution":{"type":"array","items":{"type":"integer","minimum":0,"maximum":9007199254740991},"description":"How many ratings gave each point, the scale's lowest first."}},"required":["metric","artifactId","questionId","n","customers","mean","sd","interval","precision","distribution"],"additionalProperties":false},"description":"Each metric of each creative: metrics in setup's order, then creatives in theirs."},"overall":{"type":"array","items":{"type":"object","properties":{"artifactId":{"type":"string"},"n":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The respondents who rated it."},"customers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct respondents behind the figure."},"mean":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Unrounded, on the scale's values; null when nobody rated."},"sd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The sample standard deviation; null for fewer than two values."},"interval":{"anyOf":[{"type":"object","properties":{"low":{"type":"number"},"high":{"type":"number"}},"required":["low","high"],"additionalProperties":false,"description":"The 95% interval: the mean ± 1.96 standard errors, on the scale's values."},{"type":"null"}],"description":"Null for fewer than two values."},"precision":{"$ref":"#/components/schemas/ResearchPrecision"}},"required":["artifactId","n","customers","mean","sd","interval","precision"],"additionalProperties":false},"description":"Each creative over its metrics: the mean of each respondent's own mean rating, so a respondent counts once."},"leaders":{"type":"array","items":{"type":"string"},"description":"The creatives with the highest overall mean, tied ones together; no verdict."},"comparisons":{"type":"array","items":{"type":"object","properties":{"artifactId":{"type":"string"},"leader":{"type":"string","description":"The first leader, which it is compared with."},"n":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The respondents who rated both."},"minusLeader":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Their mean overall rating of this creative less the leader's."},"sd":{"anyOf":[{"type":"number"},{"type":"null"}]},"interval":{"anyOf":[{"type":"object","properties":{"low":{"type":"number"},"high":{"type":"number"}},"required":["low","high"],"additionalProperties":false,"description":"The 95% interval: the mean ± 1.96 standard errors, on the scale's values."},{"type":"null"}]}},"required":["artifactId","leader","n","minusLeader","sd","interval"],"additionalProperties":false},"description":"Every other creative's paired difference from the leader over the respondents who rated both, and its interval; whether it is a clear difference is the reader's call."},"backupAnswered":{"anyOf":[{"type":"object","properties":{"interviews":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Interviews a declared backup model answered a turn of."},"of":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The shown run's delivered interviews."}},"required":["interviews","of"],"additionalProperties":false},{"type":"null"}],"description":"How many of the shown run's interviews a backup answered in part."}},"required":["status","scale","metrics","creatives","measures","cells","overall","leaders","comparisons","backupAnswered"],"additionalProperties":false},{"type":"null"}],"description":"A creative test that named its metrics, as a machine reads it; null for any other study."},"instrument":{"anyOf":[{"type":"object","properties":{"hash":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The frozen study's spec hash."},"schemaVersion":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The spec contract it was frozen under; null for an unversioned instrument."}},"required":["hash","schemaVersion"],"additionalProperties":false},{"type":"null"}],"description":"The frozen study the figures read; null before a campaign is selected."},"models":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","description":"The model operation its calls ran."},"assigned":{"anyOf":[{"type":"object","properties":{"modelId":{"type":"string"},"provider":{"type":"string"}},"required":["modelId","provider"],"additionalProperties":false},{"type":"null"}],"description":"The model its frozen assignment requested; null when only a backup ran."},"served":{"type":"array","items":{"type":"object","properties":{"modelId":{"type":"string"},"provider":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The route that served it, as recorded."},"calls":{"type":"integer","minimum":0,"maximum":9007199254740991},"backup":{"type":"boolean","description":"A declared backup answered these calls."}},"required":["modelId","provider","calls","backup"],"additionalProperties":false}}},"required":["role","assigned","served"],"additionalProperties":false},"description":"The shown run's models by role; empty before any run."}},"required":["campaignId","study","description","assumptions","onCalendar","runId","runDay","runStatus","runDelayed","analysisRerunnable","coverage","entry","range","interactionDays","widenedToAllTime","rows","scorecard","segments","creativeScorecard","instrument","models"],"additionalProperties":false},"ResearchResultsGetV6Response":{"type":"object","properties":{"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"study":{"type":"string","enum":["ad_copy","brand_health","offers","pricing","product","product_launch","sales","custom","product_roadmap","purchasing","competitors"]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The study's description as its author wrote it under the name in the study editor; null when it has none, as on every study launched before launch kept it."},"assumptions":{"type":"array","items":{"type":"string"},"description":"The customer assumptions every answer assumes: statements each respondent took as true of themselves for this study only, beside their own profile, in order. A saved run (runId) answers the ones it froze: the study's, and any a backtest's rerun added. Empty when the study states none."},"onCalendar":{"type":"boolean","description":"The study runs weekly or monthly, so a settings Save changes it from its next admission day; false for a study that runs once."},"runId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The run whose status, coverage and synthesized titles, summaries and quotes the results show: the saved run named, else the newest run with an interview in the date range; null before any run."},"runDay":{"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}],"description":"The UTC day the run started; null before any run."},"runStatus":{"anyOf":[{"type":"string","enum":["running","succeeded","failed","cancelled","partial"]},{"type":"null"}]},"runDelayed":{"type":"boolean","description":"The running run is past its phase's maximum wait with no terminal receipt."},"analysisRerunnable":{"type":"boolean","description":"The run failed after its interviews were analyzed; research.runs.reanalyze.v1 re-runs its analysis at no interview charge."},"coverage":{"anyOf":[{"type":"object","properties":{"requested":{"type":"integer","minimum":0,"maximum":9007199254740991},"reserved":{"type":"integer","minimum":0,"maximum":9007199254740991},"attempted":{"type":"integer","minimum":0,"maximum":9007199254740991},"completed":{"type":"integer","minimum":0,"maximum":9007199254740991},"extracted":{"type":"integer","minimum":0,"maximum":9007199254740991},"failed":{"type":"integer","minimum":0,"maximum":9007199254740991},"unresolved":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["requested","reserved","attempted","completed","extracted","failed","unresolved"],"additionalProperties":false},{"type":"null"}],"description":"The run's interviews owed and delivered; null before any run."},"entry":{"$ref":"#/components/schemas/ResearchEntry"},"range":{"$ref":"#/components/schemas/ResearchRange"},"interactionDays":{"anyOf":[{"type":"object","properties":{"first":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"The UTC day of the campaign's first interview."},"last":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"The UTC day of its last."}},"required":["first","last"],"additionalProperties":false},{"type":"null"}],"description":"The days of the campaign's first and last interviews, whatever the range; null before its first and on a saved run's results. With a null range, the range holds neither nor any between them."},"widenedToAllTime":{"type":"boolean","description":"A dateRange with widenWhenEmpty held no interview, so the figures read All time."},"rows":{"$ref":"#/components/schemas/ResearchRows"},"scorecard":{"$ref":"#/components/schemas/ResearchScorecard"},"segments":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"axis":{"type":"string","enum":["audience","channel","market","age","householdIncome","education","lifeStage","areaType","companySize","buyerRole","seniority","occupation","job","triggerType","intentStage","language","gender","store","customer"]},"id":{"type":"string","minLength":1,"maxLength":512},"label":{"description":"The entry's name as research.campaign-segments.get.v1 lists it (audience, channel and store entries only); absent for any other axis or for a member the campaign's active roster does not hold.","type":"string"}},"required":["axis","id"],"additionalProperties":false},"description":"The scope the figures were read under."}},"required":["campaignId","study","description","assumptions","onCalendar","runId","runDay","runStatus","runDelayed","analysisRerunnable","coverage","entry","range","interactionDays","widenedToAllTime","rows","scorecard","segments"],"additionalProperties":false},"ResearchResultsGetV5Response":{"type":"object","properties":{"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"study":{"type":"string","enum":["ad_copy","brand_health","offers","pricing","product","product_launch","sales","custom","product_roadmap","purchasing","competitors"]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The study's description as its author wrote it under the name in the study editor; null when it has none, as on every study launched before launch kept it."},"assumptions":{"type":"array","items":{"type":"string"},"description":"The customer assumptions every answer assumes: statements each respondent took as true of themselves for this study only, beside their own profile, in order. A saved run (runId) answers the ones it froze: the study's, and any a backtest's rerun added. Empty when the study states none."},"onCalendar":{"type":"boolean","description":"The study runs weekly or monthly, so a settings Save changes it from its next admission day; false for a study that runs once."},"runId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The run whose status, coverage and synthesized titles, summaries and quotes the results show: the saved run named, else the newest run with an interview in the date range; null before any run."},"runDay":{"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}],"description":"The UTC day the run started; null before any run."},"runStatus":{"anyOf":[{"type":"string","enum":["running","succeeded","failed","cancelled","partial"]},{"type":"null"}]},"runDelayed":{"type":"boolean","description":"The running run is past its phase's maximum wait with no terminal receipt."},"analysisRerunnable":{"type":"boolean","description":"The run failed after its interviews were analyzed; research.runs.reanalyze.v1 re-runs its analysis at no interview charge."},"coverage":{"anyOf":[{"type":"object","properties":{"requested":{"type":"integer","minimum":0,"maximum":9007199254740991},"reserved":{"type":"integer","minimum":0,"maximum":9007199254740991},"attempted":{"type":"integer","minimum":0,"maximum":9007199254740991},"completed":{"type":"integer","minimum":0,"maximum":9007199254740991},"extracted":{"type":"integer","minimum":0,"maximum":9007199254740991},"failed":{"type":"integer","minimum":0,"maximum":9007199254740991},"unresolved":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["requested","reserved","attempted","completed","extracted","failed","unresolved"],"additionalProperties":false},{"type":"null"}],"description":"The run's interviews owed and delivered; null before any run."},"entry":{"$ref":"#/components/schemas/ResearchEntry"},"range":{"$ref":"#/components/schemas/ResearchRange"},"interactionDays":{"anyOf":[{"type":"object","properties":{"first":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"The UTC day of the campaign's first interview."},"last":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"The UTC day of its last."}},"required":["first","last"],"additionalProperties":false},{"type":"null"}],"description":"The days of the campaign's first and last interviews, whatever the range; null before its first and on a saved run's results. With a null range, the range holds neither nor any between them."},"widenedToAllTime":{"type":"boolean","description":"A dateRange with widenWhenEmpty held no interview, so the figures read All time."},"rows":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"gate"},"title":{"type":"string"},"base":{"type":"string","description":"The respondents counted, as `n = …`."}},"required":["kind","title","base"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"question"},"id":{"type":"string","description":"The question id."},"badge":{"type":"string"},"title":{"type":"string"},"question":{"type":"string"},"shape":{"description":"The question's authored type; absent when it has left the instrument.","type":"string","enum":["open_ended","closed_ended","multi_select","rank","matrix","scale","computer_task"]},"attachment":{"description":"The file the question introduced to respondents; absent when it introduced none.","type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":104857600}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false},"average":{"description":"A scale's or matrix's mean rating on its authored range.","type":"object","properties":{"value":{"type":"number"},"max":{"type":"number"}},"required":["value","max"],"additionalProperties":false},"summary":{"description":"The shown run's synthesized summary, campaign-wide; absent when it has none.","type":"string"},"analysisCoverage":{"type":"object","properties":{"aggregateResponses":{"type":"integer","minimum":0,"maximum":9007199254740991},"summaryResponses":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["aggregateResponses","summaryResponses"],"additionalProperties":false},"evidence":{"description":"The shown run's synthesized evidence quotes, campaign-wide.","type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"quote":{"type":"string"}},"required":["label","quote"],"additionalProperties":false}},"primary":{"description":"The figure the card leads with; absent unanswered.","type":"object","properties":{"label":{"type":"string"},"value":{"type":"number","description":"A whole percent, 0 to 100."},"tone":{"type":"string","enum":["positive","neutral","negative"]},"averageRank":{"description":"A ranked option's mean position, 1 = first; ranking questions only.","type":"number"},"optionIndex":{"description":"The option's place among the question's authored options, 0 = first; counted choice and ranking figures only.","type":"integer","minimum":0,"maximum":9007199254740991}},"required":["label","value","tone"],"additionalProperties":false},"slices":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"number","description":"A whole percent, 0 to 100."},"tone":{"type":"string","enum":["positive","neutral","negative"]},"averageRank":{"description":"A ranked option's mean position, 1 = first; ranking questions only.","type":"number"},"optionIndex":{"description":"The option's place among the question's authored options, 0 = first; counted choice and ranking figures only.","type":"integer","minimum":0,"maximum":9007199254740991}},"required":["label","value","tone"],"additionalProperties":false}},"detailTitle":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string","description":"The detail's figure as the dashboard reads it."},"tone":{"type":"string","enum":["positive","neutral","negative"]}},"required":["label","value","tone"],"additionalProperties":false}},"sampleCount":{"description":"The accepted answers the figure counted: on every range's results, and on a saved run's under a segment.","type":"integer","minimum":0,"maximum":9007199254740991},"headline":{"$ref":"#/components/schemas/ResearchHeadline"}},"required":["kind","id","badge","title","question","slices"],"additionalProperties":false}]}},"scorecard":{"$ref":"#/components/schemas/ResearchScorecard"},"segments":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"axis":{"type":"string","enum":["audience","channel","market","age","householdIncome","education","lifeStage","areaType","companySize","buyerRole","seniority","occupation","job","triggerType","intentStage","language","gender","store","customer"]},"id":{"type":"string","minLength":1,"maxLength":512},"label":{"description":"The entry's name as research.campaign-segments.get.v1 lists it (audience, channel and store entries only); absent for any other axis or for a member the campaign's active roster does not hold.","type":"string"}},"required":["axis","id"],"additionalProperties":false},"description":"The scope the figures were read under."}},"required":["campaignId","study","description","assumptions","onCalendar","runId","runDay","runStatus","runDelayed","analysisRerunnable","coverage","entry","range","interactionDays","widenedToAllTime","rows","scorecard","segments"],"additionalProperties":false},"ResearchResultsExportV3Response":{"type":"object","properties":{"fileName":{"type":"string"},"mediaType":{"type":"string","const":"text/csv"},"content":{"type":"string","description":"The whole file: a header line, then one line per answer row."},"rowCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Lines after the header."}},"required":["fileName","mediaType","content","rowCount"],"additionalProperties":false},"ResearchResultsExportV2Response":{"type":"object","properties":{"fileName":{"type":"string"},"mediaType":{"type":"string","const":"text/csv"},"content":{"type":"string","description":"The whole file: a header line, then one line per answer row."},"rowCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Lines after the header."}},"required":["fileName","mediaType","content","rowCount"],"additionalProperties":false},"ResearchResultsExportResponse":{"type":"object","properties":{"fileName":{"type":"string"},"mediaType":{"type":"string","const":"text/csv"},"content":{"type":"string","description":"The whole file: a header line, then one line per answer row."},"rowCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Lines after the header."}},"required":["fileName","mediaType","content","rowCount"],"additionalProperties":false},"ResearchResultSegmentsGetV4Response":{"type":"object","properties":{"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The study's description as its author wrote it; null when it has none."},"runId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The run whose synthesis the cards show; null before any run."},"segments":{"type":"array","items":{"type":"object","properties":{"axis":{"type":"string","enum":["audience","channel","store","product","sentiment","topic"]},"id":{"type":"string","description":"The entry's id: an audience, channel or store entry's as research.campaign-segments.get.v1 lists it, a product's revenue line id from the business profile's revenue mix, a tone (positive, neutral, negative), or a topic's tag text folded by case and spacing."},"label":{"type":"string"},"respondents":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The most answers any one question counted under the entry."}},"required":["axis","id","label","respondents"],"additionalProperties":false},"description":"Every audience, then channel, then store, then product (revenue line) entry, each axis by label; then each tone a respondent's toned open answers mostly took (a tie places it under none), then the topics the most respondents' answer tags carry, by label. A respondent counts under every topic its answers carry."},"questions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The question id."},"badge":{"type":"string"},"question":{"type":"string"},"shape":{"anyOf":[{"type":"string","enum":["open_ended","closed_ended","multi_select","rank","matrix","scale","computer_task"]},{"type":"null"}],"description":"The question's authored type; null when it has left the instrument."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The run's synthesized summary, campaign-wide."},"overall":{"type":"object","properties":{"n":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The accepted answers the figure counts, as research.results.get.v5's sampleCount."},"slices":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"number","description":"A whole percent, 0 to 100."},"tone":{"type":"string","enum":["positive","neutral","negative"]},"averageRank":{"description":"A ranked option's mean position, 1 = first; ranking questions only.","type":"number"},"optionIndex":{"description":"The option's place among the question's authored options, 0 = first; counted choice and ranking figures only.","type":"integer","minimum":0,"maximum":9007199254740991}},"required":["label","value","tone"],"additionalProperties":false}},"primary":{"anyOf":[{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"number","description":"A whole percent, 0 to 100."},"tone":{"type":"string","enum":["positive","neutral","negative"]},"averageRank":{"description":"A ranked option's mean position, 1 = first; ranking questions only.","type":"number"},"optionIndex":{"description":"The option's place among the question's authored options, 0 = first; counted choice and ranking figures only.","type":"integer","minimum":0,"maximum":9007199254740991}},"required":["label","value","tone"],"additionalProperties":false},{"type":"null"}],"description":"The figure the card leads with; null unanswered."},"average":{"anyOf":[{"type":"object","properties":{"value":{"type":"number"},"max":{"type":"number"}},"required":["value","max"],"additionalProperties":false},{"type":"null"}],"description":"A scale's or matrix's mean rating on its authored range; null otherwise."},"customers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct respondents behind those answers: the sample the figure stands on, whose precision it reads."}},"required":["n","slices","primary","average","customers"],"additionalProperties":false,"description":"The figure campaign-wide."},"segments":{"type":"array","items":{"type":"object","properties":{"axis":{"type":"string","enum":["audience","channel","store","product","sentiment","topic"]},"id":{"type":"string"},"n":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The accepted answers the figure counts, as research.results.get.v5's sampleCount."},"slices":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"number","description":"A whole percent, 0 to 100."},"tone":{"type":"string","enum":["positive","neutral","negative"]},"averageRank":{"description":"A ranked option's mean position, 1 = first; ranking questions only.","type":"number"},"optionIndex":{"description":"The option's place among the question's authored options, 0 = first; counted choice and ranking figures only.","type":"integer","minimum":0,"maximum":9007199254740991}},"required":["label","value","tone"],"additionalProperties":false}},"primary":{"anyOf":[{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"number","description":"A whole percent, 0 to 100."},"tone":{"type":"string","enum":["positive","neutral","negative"]},"averageRank":{"description":"A ranked option's mean position, 1 = first; ranking questions only.","type":"number"},"optionIndex":{"description":"The option's place among the question's authored options, 0 = first; counted choice and ranking figures only.","type":"integer","minimum":0,"maximum":9007199254740991}},"required":["label","value","tone"],"additionalProperties":false},{"type":"null"}],"description":"The figure the card leads with; null unanswered."},"average":{"anyOf":[{"type":"object","properties":{"value":{"type":"number"},"max":{"type":"number"}},"required":["value","max"],"additionalProperties":false},{"type":"null"}],"description":"A scale's or matrix's mean rating on its authored range; null otherwise."},"customers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct respondents behind those answers: the sample the figure stands on, whose precision it reads."}},"required":["axis","id","n","slices","primary","average","customers"],"additionalProperties":false},"description":"The figure under each entry, in the order `segments` lists the entries."}},"required":["id","badge","question","shape","summary","overall","segments"],"additionalProperties":false}},"range":{"anyOf":[{"$ref":"#/components/schemas/ResearchRangeVariant"},{"type":"null"}],"description":"The date range every figure is read over: every interview completed on its days. Null on a saved run's, before the first interview, and when the range holds no interview."},"interactionDays":{"anyOf":[{"type":"object","properties":{"first":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"The UTC day of the campaign's first interview."},"last":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"The UTC day of its last."}},"required":["first","last"],"additionalProperties":false},{"type":"null"}],"description":"The days of the campaign's first and last interviews, whatever the range; null before its first and on a saved run's."},"widenedToAllTime":{"type":"boolean","description":"A dateRange with widenWhenEmpty held no interview, so the figures read All time."}},"required":["campaignId","description","runId","segments","questions","range","interactionDays","widenedToAllTime"],"additionalProperties":false},"ResearchResultSegmentAxesGetV2Response":{"type":"object","properties":{"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"axes":{"type":"array","items":{"type":"string","enum":["audience","channel","store","product","sentiment","topic"]},"description":"The axes research.result-segments.get.v4 lists an entry on, in its order: audience, channel, store, product, sentiment, topic."}},"required":["campaignId","axes"],"additionalProperties":false},"ResearchRunsGetResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"campaignName":{"anyOf":[{"type":"string"},{"type":"null"}]},"study":{"type":"string","enum":["ad_copy","brand_health","offers","pricing","product","product_launch","sales","custom","product_roadmap","purchasing","competitors"]}},"required":["id","campaignId","campaignName","study"],"additionalProperties":false},"ResearchRunsReanalyzeRequest":{"type":"object","properties":{"runId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The failed run, from research.results.get.v5 or research.runs.get.v1."}},"required":["runId"],"additionalProperties":false},"ResearchRunsReanalyzeResponse":{"type":"object","properties":{"runId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The new run that re-runs the analysis."},"entryId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The campaign entry this request started; read its progress with campaigns.campaign-entries.get.v1."},"sourceRunId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The failed run whose saved interviews and extracts it reads."},"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["runId","entryId","sourceRunId","campaignId"],"additionalProperties":false},"ResearchBacktestsGetResponse":{"type":"object","properties":{"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"campaignName":{"type":"string"},"situation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What every twin read first."},"questions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"prompt":{"type":"string"},"options":{"type":"array","items":{"type":"string"}}},"required":["id","title","prompt","options"],"additionalProperties":false}},"mapping":{"anyOf":[{"type":"object","properties":{"questionId":{"type":"string"},"keeps":{"type":"array","items":{"anyOf":[{"type":"number"},{"type":"null"}]}}},"required":["questionId","keeps"],"additionalProperties":false},{"type":"null"}]},"outcome":{"anyOf":[{"type":"object","properties":{"metric":{"type":"string"},"change":{"type":"number"},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"recordedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["metric","change","note","recordedAt"],"additionalProperties":false},{"type":"null"}]},"runs":{"type":"array","items":{"type":"object","properties":{"runId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sequence":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"entry":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"launch for the first run, run_now for a rerun."},"status":{"type":"string"},"startedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"completedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"respondentModelIds":{"type":"array","items":{"type":"string"}},"requestedModelId":{"anyOf":[{"type":"string"},{"type":"null"}]},"steeringContext":{"anyOf":[{"type":"string"},{"type":"null"}]},"counts":{"anyOf":[{"type":"array","items":{"type":"integer","minimum":0,"maximum":9007199254740991}},{"type":"null"}]},"forecast":{"anyOf":[{"type":"object","properties":{"counted":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The twins whose answers count."},"change":{"type":"number","description":"The forecast change in buying, as a fraction."},"low":{"type":"number","description":"The forecast's 95% range, most loss first."},"high":{"type":"number"}},"required":["counted","change","low","high"],"additionalProperties":false},{"type":"null"}]},"comparison":{"anyOf":[{"type":"object","properties":{"gapPoints":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Forecast less outcome, in points; negative when the twins expected more loss."},"directionMatched":{"type":"boolean"},"rangeHoldsActual":{"type":"boolean"}},"required":["gapPoints","directionMatched","rangeHoldsActual"],"additionalProperties":false},{"type":"null"}]},"overlapWithFirst":{"anyOf":[{"type":"number","minimum":0,"maximum":1},{"type":"null"}]},"drivers":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"attribute":{"type":"string","description":"The customer attribute's key."},"label":{"type":"string"},"strengthPoints":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}],"description":"The spread between its highest and lowest bucket forecast, in points, over buckets large enough to read; null with fewer than two."},"buckets":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"n":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"The twins in it whose answers count."},"forecast":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Its forecast change in buying, as a fraction, as the run's forecast."},"tooSmall":{"type":"boolean","description":"Too few twins to read; shown with its n."}},"required":["value","n","forecast","tooSmall"],"additionalProperties":false}}},"required":["attribute","label","strengthPoints","buckets"],"additionalProperties":false}},{"type":"null"}],"description":"The finished run's counted answers split by each participant attribute that varies among them, strongest first; null until the run has finished under a mapping."}},"required":["runId","sequence","entry","status","startedAt","completedAt","respondentModelIds","requestedModelId","steeringContext","counts","forecast","comparison","overlapWithFirst","drivers"],"additionalProperties":false}},"rerunTwins":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["campaignId","campaignName","situation","questions","mapping","outcome","runs","rerunTwins"],"additionalProperties":false},"ResearchBacktestMappingsUpdateRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The backtest's campaign id."},"questionId":{"type":"string","minLength":1,"description":"The single-choice question that asks the decision."},"keeps":{"minItems":1,"maxItems":100,"type":"array","items":{"anyOf":[{"type":"number","minimum":0,"maximum":2},{"type":"null"}]},"description":"By option position: the share of usual buying the answer keeps (0 stops, 1 keeps, up to 2 buys more), or null to leave it out."}},"required":["id","questionId","keeps"],"additionalProperties":false},"ResearchBacktestMappingsUpdateResponse":{"type":"object","properties":{"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["campaignId"],"additionalProperties":false},"ResearchBacktestOutcomesUpdateRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The backtest's campaign id."},"outcome":{"anyOf":[{"type":"object","properties":{"metric":{"type":"string","minLength":1,"maxLength":120,"description":"What was measured, such as \"Units sold a week\"."},"change":{"type":"number","minimum":-1,"maximum":100,"description":"The measured change, as a fraction: -0.3 is a 30% drop."},"note":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]}},"required":["metric","change"],"additionalProperties":false},{"type":"null"}],"description":"What really happened, or null to clear it."}},"required":["id","outcome"],"additionalProperties":false},"ResearchBacktestOutcomesUpdateResponse":{"type":"object","properties":{"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["campaignId"],"additionalProperties":false},"ResearchBacktestsRerunV2Request":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The backtest's campaign id."},"respondentModelId":{"description":"The respondent model the twins answer on; absent or null keeps the default.","anyOf":[{"type":"string","enum":["anthropic/claude-sonnet-5","openai/gpt-6-astra","google/gemini-3.8-flash","xai/grok-4.3"]},{"type":"null"}]},"assumptions":{"description":"Customer assumptions to add for this run's twins, in order: statements each twin takes as true of themselves beside its own facts, after any the study already states. Each is at most 2,000 characters and none is empty; the study's and these together are at most 10. Absent or empty adds none.","maxItems":10,"type":"array","items":{"type":"string"}}},"required":["id"],"additionalProperties":false},"ResearchBacktestsRerunV2Response":{"type":"object","properties":{"runId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"entryId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The campaign entry this request started; read its progress with campaigns.campaign-entries.get.v1."},"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["runId","entryId","campaignId"],"additionalProperties":false},"ResearchBacktestsRerunRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The backtest's campaign id."},"respondentModelId":{"anyOf":[{"type":"string","enum":["anthropic/claude-sonnet-5","openai/gpt-6-astra","google/gemini-3.8-flash","xai/grok-4.3"]},{"type":"null"}],"description":"The respondent model the twins answer on, or null to keep the default."},"context":{"anyOf":[{"type":"string","maxLength":4000},{"type":"null"}],"description":"Added as one customer assumption for the twins, at most 2,000 characters, or null to add nothing."}},"required":["id","respondentModelId","context"],"additionalProperties":false,"deprecated":true},"ResearchBacktestsRerunResponse":{"type":"object","properties":{"runId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"entryId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The campaign entry this request started; read its progress with campaigns.campaign-entries.get.v1."},"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["runId","entryId","campaignId"],"additionalProperties":false},"ResearchStudiesPrefillRequest":{"type":"object","properties":{"playbookKey":{"type":"string","enum":["ad_copy","brand_health","offers","pricing","product","product_launch","sales","custom","product_roadmap"]},"profileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The business profile the fills are written for."},"questions":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/ResearchQuestionsItem"},"description":"The draft's questions as they stand; the open slots are derived from them, never sent."},"material":{"$ref":"#/components/schemas/ResearchMaterial"}},"required":["playbookKey","profileId","questions","material"],"additionalProperties":false},"ResearchStudiesPrefillResponse":{"type":"object","properties":{"runId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The billing run that paid for these fills in Alpha credits."},"fills":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","minLength":1,"maxLength":300},"value":{"type":"string","minLength":1,"maxLength":5000}},"required":["slot","value"],"additionalProperties":false},"description":"One value per filled slot, as the model returned them; a slot left out stays blank."}},"required":["runId","fills"],"additionalProperties":false},"ResearchCreativeTestsStartRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"brief":{"type":"string","minLength":1,"maxLength":10000,"description":"What to learn from the creative. With artifactId, Research names the selected creative before it; with attachments, the whole brief."},"sellerProfileId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"contentLanguage":{"type":"string","enum":["en","fr","es","de","pt","ja","it","nl","sv","cs","pl","tr","ru","zh-Hans","ko","ar"]},"audience":{"type":"object","properties":{"audienceProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"targetedGroupIds":{"anyOf":[{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"type":"null"}]},"targetedCustomerIds":{"anyOf":[{"minItems":1,"maxItems":1000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"type":"null"}]},"targetInterviewCount":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["audienceProfileId","targetedGroupIds","targetedCustomerIds","targetInterviewCount"],"additionalProperties":false},"audienceNote":{"description":"Anything more about who the people taking part are, in the member's own words; the Designer reads it after the brief.","type":"string","minLength":1,"maxLength":2000},"studyMode":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"first_impressions"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"buying_scenario"},"direction":{"type":"string","maxLength":10000}},"required":["kind","direction"],"additionalProperties":false}]},"metrics":{"description":"What to rate each creative on. Each becomes one rating question per creative, which the results' scorecard compares. Omit to let the study choose its own questions.","minItems":1,"maxItems":9,"type":"array","items":{"type":"string","enum":["stopping_power","clarity","relevance","appeal","believability","distinctiveness","brand_clarity","platform_fit","intent_to_act"]}},"chooseMetrics":{"description":"Let the study's Designer choose, from the brief, which metrics to rate each creative on (or none), as many as fit one study. Takes no metrics.","type":"boolean","const":true},"platforms":{"description":"Where the creative might run; the study shows it as people would meet it there. Platform fit needs at least one.","maxItems":18,"type":"array","items":{"type":"string","enum":["Facebook","Instagram","Google Search","YouTube","LinkedIn","TikTok","Gmail","Discover","Google Display","Microsoft / Bing","Pinterest","Reddit","Amazon","Snapchat","Spotify and podcasts","X","Website","Email and messaging"]}},"attachments":{"description":"Files already uploaded with research.study-attachments. Omit when artifactId names the creative.","maxItems":100,"type":"array","items":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm","audio/mpeg","audio/wav"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":104857600}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false}},"artifactId":{"description":"An exact Studio creative artifact or package the signed-in member may read; Research imports its files under this request's Idempotency-Key. Members only; an API key passes attachments.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"expectedPrice":{"description":"The expectedPrice research_creative_test_quotes_get answered for this audience: the start is refused, before anything is paid for, if the interviews it would run no longer price at it, and so is the launch, reserving nothing (failure launch, code price_changed), if they no longer do when they are reserved.","type":"object","properties":{"productSlug":{"type":"string","minLength":1,"maxLength":160},"dimensionKey":{"type":"string","minLength":1,"maxLength":160},"unitPriceCents":{"type":"integer","minimum":0,"maximum":100000000},"quantity":{"type":"integer","minimum":1,"maximum":1000000},"totalCents":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["productSlug","dimensionKey","unitPriceCents","quantity","totalCents"],"additionalProperties":false}},"required":["name","brief","sellerProfileId","contentLanguage","audience","studyMode"],"additionalProperties":false},"ResearchCreativeTestsStartResponse":{"type":"object","properties":{"name":{"type":"string"},"attachments":{"type":"array","items":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm","audio/mpeg","audio/wav"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":104857600}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false}},"preparationRunId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"status":{"type":"string","enum":["preparing","unsupported","failed","launched"],"description":"A test cancelled after launch (its campaign deleted, or its run stopped) reads failed here; research_creative_tests_get_v2 reads it cancelled."},"campaignId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"runId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"message":{"anyOf":[{"type":"string"},{"type":"null"}]},"studyMode":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"first_impressions"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"buying_scenario"},"direction":{"type":"string","maxLength":10000}},"required":["kind","direction"],"additionalProperties":false}]},"metrics":{"type":"array","items":{"type":"string","enum":["stopping_power","clarity","relevance","appeal","believability","distinctiveness","brand_clarity","platform_fit","intent_to_act"]},"description":"What each creative is rated on, as the start named them or the Designer chose them; empty when the study chose its own questions, and until the Designer has chosen."},"platforms":{"type":"array","items":{"type":"string","enum":["Facebook","Instagram","Google Search","YouTube","LinkedIn","TikTok","Gmail","Discover","Google Display","Microsoft / Bing","Pinterest","Reddit","Amazon","Snapchat","Spotify and podcasts","X","Website","Email and messaging"]},"description":"Where the creative might run."},"phase":{"type":"string","enum":["reading_creative","preparing_participants","interviewing","analyzing","results","failed","unsupported"]},"selection":{"type":"array","items":{"type":"object","properties":{"customerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customerVersionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"contentFingerprint":{"type":"string","pattern":"^[a-f0-9]{64}$"},"displayName":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["customerId","customerVersionId","version","contentFingerprint","displayName"],"additionalProperties":false}},"plannedInterviewCount":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"preparation":{"type":"object","properties":{"required":{"type":"integer","minimum":0,"maximum":9007199254740991},"completed":{"type":"integer","minimum":0,"maximum":9007199254740991},"failed":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["required","completed","failed"],"additionalProperties":false},"interviews":{"type":"object","properties":{"completed":{"type":"integer","minimum":0,"maximum":9007199254740991},"failed":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["completed","failed"],"additionalProperties":false},"interpretation":{"$ref":"#/components/schemas/ResearchInterpretation"},"scenario":{"anyOf":[{"type":"object","properties":{"condition":{"type":"string"},"respondentExposure":{"type":"string"},"limitations":{"type":"array","items":{"type":"string"}}},"required":["condition","respondentExposure","limitations"],"additionalProperties":false},{"type":"null"}]}},"required":["name","attachments","preparationRunId","status","campaignId","runId","message","studyMode","metrics","platforms","phase","selection","plannedInterviewCount","preparation","interviews","interpretation","scenario"],"additionalProperties":false},"ResearchCreativeTestsGetV2Response":{"type":"object","properties":{"name":{"type":"string"},"attachments":{"type":"array","items":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm","audio/mpeg","audio/wav"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":104857600}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false}},"preparationRunId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"status":{"type":"string","enum":["preparing","unsupported","failed","cancelled","launched"],"description":"cancelled once a launched test's campaign was deleted (campaigns_lifecycles_delete) or its run stopped."},"campaignId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"runId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"message":{"anyOf":[{"type":"string"},{"type":"null"}]},"studyMode":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"first_impressions"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"buying_scenario"},"direction":{"type":"string","maxLength":10000}},"required":["kind","direction"],"additionalProperties":false}]},"metrics":{"type":"array","items":{"type":"string","enum":["stopping_power","clarity","relevance","appeal","believability","distinctiveness","brand_clarity","platform_fit","intent_to_act"]},"description":"What each creative is rated on, as the start named them or the Designer chose them; empty when the study chose its own questions, and until the Designer has chosen."},"platforms":{"type":"array","items":{"type":"string","enum":["Facebook","Instagram","Google Search","YouTube","LinkedIn","TikTok","Gmail","Discover","Google Display","Microsoft / Bing","Pinterest","Reddit","Amazon","Snapchat","Spotify and podcasts","X","Website","Email and messaging"]},"description":"Where the creative might run."},"phase":{"type":"string","enum":["reading_creative","preparing_participants","interviewing","analyzing","results","failed","cancelled","unsupported"]},"selection":{"type":"array","items":{"type":"object","properties":{"customerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customerVersionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"contentFingerprint":{"type":"string","pattern":"^[a-f0-9]{64}$"},"displayName":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["customerId","customerVersionId","version","contentFingerprint","displayName"],"additionalProperties":false}},"plannedInterviewCount":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"preparation":{"type":"object","properties":{"required":{"type":"integer","minimum":0,"maximum":9007199254740991},"completed":{"type":"integer","minimum":0,"maximum":9007199254740991},"failed":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["required","completed","failed"],"additionalProperties":false},"interviews":{"type":"object","properties":{"completed":{"type":"integer","minimum":0,"maximum":9007199254740991},"failed":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["completed","failed"],"additionalProperties":false},"interpretation":{"$ref":"#/components/schemas/ResearchInterpretation"},"scenario":{"anyOf":[{"type":"object","properties":{"condition":{"type":"string"},"respondentExposure":{"type":"string"},"limitations":{"type":"array","items":{"type":"string"}}},"required":["condition","respondentExposure","limitations"],"additionalProperties":false},{"type":"null"}]},"failure":{"anyOf":[{"type":"object","properties":{"stage":{"type":"string","enum":["design","preparation","launch","interviews"],"description":"Where the test failed: the Designer, a participant's preparation, its launch, or the launched run's interviews."},"code":{"type":"string","description":"Why, as its owner recorded it: a launch refused by Billing names Billing's reason (such as interaction_unavailable), one whose quoted price moved price_changed; interviews name the launched run's status."},"paymentDisputeHold":{"description":"Present when the message words the account's payment-dispute hold.","type":"boolean","const":true}},"required":["stage","code"],"additionalProperties":false},{"type":"null"}],"description":"Why a failed test failed; null unless status is failed."},"creatives":{"type":"array","items":{"type":"object","properties":{"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"filename":{"type":"string"},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm","audio/mpeg","audio/wav"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"sha256":{"type":"string","pattern":"^[0-9a-f]{64}$","description":"The stored file's digest, as the test froze it."},"storyboard":{"anyOf":[{"type":"object","properties":{"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sha256":{"type":"string","pattern":"^[0-9a-f]{64}$"}},"required":["artifactId","sha256"],"additionalProperties":false},{"type":"null"}],"description":"A video's storyboard manifest, the frames and transcript a model sees."}},"required":["artifactId","filename","mediaType","byteLength","sha256","storyboard"],"additionalProperties":false},"description":"Every file the test froze and shows, by digest."},"roster":{"type":"object","properties":{"audienceProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"participants":{"type":"array","items":{"type":"object","properties":{"customerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customerVersionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"snapshotHash":{"type":"string","pattern":"^[0-9a-f]{64}$","description":"The digest of the Research snapshot frozen from that exact Customer Version."}},"required":["customerId","customerVersionId","version","snapshotHash"],"additionalProperties":false}}},"required":["audienceProfileId","participants"],"additionalProperties":false,"description":"The exact people the test interviews, each at the Customer Version it froze."},"seller":{"anyOf":[{"type":"object","properties":{"profileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"profileVersionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["profileId","profileVersionId"],"additionalProperties":false},{"type":"null"}],"description":"The seller profile version the test was designed with; null without one."},"measures":{"type":"array","items":{"type":"object","properties":{"metric":{"type":"string","enum":["stopping_power","clarity","relevance","appeal","believability","distinctiveness","brand_clarity","platform_fit","intent_to_act"],"description":"The metric the question rates."},"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The rated creative: its attachment's artifactId."},"questionId":{"type":"string","minLength":1,"description":"The scale question that asks it."}},"required":["metric","artifactId","questionId"],"additionalProperties":false},"description":"The Designer's measures: the scale question that rates each named metric of each creative. Empty for a test that named no metrics."},"participants":{"type":"array","items":{"type":"object","properties":{"customerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customerVersionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"status":{"type":"string","enum":["reserved","running","succeeded","failed"]},"outcome":{"anyOf":[{"type":"string","enum":["prepared","unchanged_baseline","unsupported"]},{"type":"null"}],"description":"The preparation's outcome once delivered; null before, or once erased."},"failureCode":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["customerId","customerVersionId","status","outcome","failureCode"],"additionalProperties":false},"description":"Each participant's buying-scenario preparation; empty for first impressions. One failed or unsupported preparation launches no interviews."},"timestamps":{"type":"object","properties":{"startedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"launchedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}],"description":"When the launched run ended, or the preparation when nothing launched."}},"required":["startedAt","launchedAt","completedAt"],"additionalProperties":false}},"required":["name","attachments","preparationRunId","status","campaignId","runId","message","studyMode","metrics","platforms","phase","selection","plannedInterviewCount","preparation","interviews","interpretation","scenario","failure","creatives","roster","seller","measures","participants","timestamps"],"additionalProperties":false},"ResearchCreativeTestsGetResponse":{"type":"object","properties":{"name":{"type":"string"},"attachments":{"type":"array","items":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm","audio/mpeg","audio/wav"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":104857600}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false}},"preparationRunId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"status":{"type":"string","enum":["preparing","unsupported","failed","launched"],"description":"A test cancelled after launch (its campaign deleted, or its run stopped) reads failed here; research_creative_tests_get_v2 reads it cancelled."},"campaignId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"runId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"message":{"anyOf":[{"type":"string"},{"type":"null"}]},"studyMode":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"first_impressions"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"buying_scenario"},"direction":{"type":"string","maxLength":10000}},"required":["kind","direction"],"additionalProperties":false}]},"metrics":{"type":"array","items":{"type":"string","enum":["stopping_power","clarity","relevance","appeal","believability","distinctiveness","brand_clarity","platform_fit","intent_to_act"]},"description":"What each creative is rated on, as the start named them or the Designer chose them; empty when the study chose its own questions, and until the Designer has chosen."},"platforms":{"type":"array","items":{"type":"string","enum":["Facebook","Instagram","Google Search","YouTube","LinkedIn","TikTok","Gmail","Discover","Google Display","Microsoft / Bing","Pinterest","Reddit","Amazon","Snapchat","Spotify and podcasts","X","Website","Email and messaging"]},"description":"Where the creative might run."},"phase":{"type":"string","enum":["reading_creative","preparing_participants","interviewing","analyzing","results","failed","unsupported"]},"selection":{"type":"array","items":{"type":"object","properties":{"customerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customerVersionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"contentFingerprint":{"type":"string","pattern":"^[a-f0-9]{64}$"},"displayName":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["customerId","customerVersionId","version","contentFingerprint","displayName"],"additionalProperties":false}},"plannedInterviewCount":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"preparation":{"type":"object","properties":{"required":{"type":"integer","minimum":0,"maximum":9007199254740991},"completed":{"type":"integer","minimum":0,"maximum":9007199254740991},"failed":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["required","completed","failed"],"additionalProperties":false},"interviews":{"type":"object","properties":{"completed":{"type":"integer","minimum":0,"maximum":9007199254740991},"failed":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["completed","failed"],"additionalProperties":false},"interpretation":{"$ref":"#/components/schemas/ResearchInterpretation"},"scenario":{"anyOf":[{"type":"object","properties":{"condition":{"type":"string"},"respondentExposure":{"type":"string"},"limitations":{"type":"array","items":{"type":"string"}}},"required":["condition","respondentExposure","limitations"],"additionalProperties":false},{"type":"null"}]}},"required":["name","attachments","preparationRunId","status","campaignId","runId","message","studyMode","metrics","platforms","phase","selection","plannedInterviewCount","preparation","interviews","interpretation","scenario"],"additionalProperties":false},"ResearchCreativeTestsListResponse":{"type":"object","properties":{"data":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The start request's Idempotency-Key, which research_creative_tests_get_v2 reads."},"preparationRunId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"status":{"type":"string","enum":["preparing","unsupported","failed","cancelled","launched"]},"campaignId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"runId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["id","preparationRunId","name","status","campaignId","runId","createdAt"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"ResearchCreativeTestQuotesGetResponse":{"type":"object","properties":{"plannedInterviewCount":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"The interviews the test would run: one per selected person."},"unitPriceCents":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The organization's interview price."},"subtotalCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"catalogRow":{"type":"object","properties":{"priceId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"version":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["priceId","version"],"additionalProperties":false,"description":"The catalog row and version that priced the interviews."},"expectedPrice":{"type":"object","properties":{"productSlug":{"type":"string","minLength":1,"maxLength":160},"dimensionKey":{"type":"string","minLength":1,"maxLength":160},"unitPriceCents":{"type":"integer","minimum":0,"maximum":100000000},"quantity":{"type":"integer","minimum":1,"maximum":1000000},"totalCents":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["productSlug","dimensionKey","unitPriceCents","quantity","totalCents"],"additionalProperties":false,"description":"Pass to research_creative_tests_start to refuse the start if this price changes."},"admission":{"type":"object","properties":{"outcome":{"type":"string","enum":["included","overage","refused","unavailable"],"description":"Billing's answer to the interviews now: within the plan, overage, refused, or unavailable when it could not be read (which refuses nothing)."},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Billing's refusal reason."},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Billing's refusal, in its own words."},"paymentDisputeHold":{"type":"boolean"}},"required":["outcome","reason","message","paymentDisputeHold"],"additionalProperties":false},"preparation":{"type":"string","const":"alpha_credits_at_cost","description":"The Designer and each participant's preparation draw Alpha credits at their exact model cost, settled after delivery; never estimated here."}},"required":["plannedInterviewCount","unitPriceCents","subtotalCents","catalogRow","expectedPrice","admission","preparation"],"additionalProperties":false},"ResearchStudyDesignsStartV3Request":{"type":"object","properties":{"playbookKey":{"type":"string","enum":["ad_copy","brand_health","offers","pricing","product","product_launch","sales","custom","product_roadmap"],"description":"Always `custom`: only a custom study is designed."},"profileId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"Seller business profile, or null for creative-only study context."},"questions":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/ResearchQuestionsItem"},"description":"The draft's questions as they stand."},"material":{"$ref":"#/components/schemas/ResearchMaterial"},"design":{"$ref":"#/components/schemas/ResearchDesign"},"contentLanguage":{"description":"The language the study is written in. Omit it to write in the profile's language, as Research's own setup page does.","type":"string","enum":["en","fr","es","de","pt","ja","it","nl","sv","cs","pl","tr","ru","zh-Hans","ko","ar"]}},"required":["playbookKey","profileId","questions","material","design"],"additionalProperties":false},"ResearchStudyDesignsStartV3Response":{"type":"object","properties":{"runId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The billing run that pays for the design in Alpha credits."},"status":{"type":"string","enum":["pending","ready"]},"design":{"$ref":"#/components/schemas/ResearchDesign2"}},"required":["runId","status","design"],"additionalProperties":false},"ResearchStudyDesignsGetV3Response":{"type":"object","properties":{"runId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The billing run that pays for the design in Alpha credits."},"status":{"type":"string","enum":["pending","failed","ready"]},"design":{"$ref":"#/components/schemas/ResearchDesign2"},"failureDisposition":{"description":"Why a failed design stopped, once its run settled: transient is worth retrying; deterministic and repairable_schema need a changed request.","type":"string","enum":["transient","repairable_schema","deterministic","cancelled","unknown","repairable_domain"]}},"required":["runId","status","design"],"additionalProperties":false},"ResearchStudyDesignsStartV2Request":{"type":"object","properties":{"playbookKey":{"type":"string","enum":["ad_copy","brand_health","offers","pricing","product","product_launch","sales","custom","product_roadmap"],"description":"Always `custom`: only a custom study is designed."},"profileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The business profile the study is designed for."},"questions":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/ResearchItem2"},"description":"The draft's questions as they stand."},"material":{"$ref":"#/components/schemas/ResearchMaterial2"},"design":{"$ref":"#/components/schemas/ResearchRequestDesign"}},"required":["playbookKey","profileId","questions","material","design"],"additionalProperties":false,"deprecated":true},"ResearchStudyDesignsStartV2Response":{"type":"object","properties":{"runId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The billing run that pays for the design in Alpha credits."},"status":{"type":"string","enum":["pending","ready"]},"design":{"$ref":"#/components/schemas/ResearchDesign3"}},"required":["runId","status","design"],"additionalProperties":false},"ResearchStudyDesignsStartRequest":{"type":"object","properties":{"playbookKey":{"type":"string","enum":["ad_copy","brand_health","offers","pricing","product","product_launch","sales","custom","product_roadmap"],"description":"Always `custom`: only a custom study is designed."},"profileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The business profile the study is designed for."},"questions":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/ResearchItem3"},"description":"The draft's questions as they stand."},"material":{"$ref":"#/components/schemas/ResearchMaterial3"},"design":{"$ref":"#/components/schemas/ResearchRequestDesign2"}},"required":["playbookKey","profileId","questions","material","design"],"additionalProperties":false,"deprecated":true},"ResearchStudyDesignsStartResponse":{"type":"object","properties":{"runId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The billing run that pays for the design in Alpha credits."},"status":{"type":"string","enum":["pending","ready"]},"design":{"$ref":"#/components/schemas/ResearchDesign4"}},"required":["runId","status","design"],"additionalProperties":false},"ResearchStudyDesignsGetV2Response":{"type":"object","properties":{"runId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The billing run that pays for the design in Alpha credits."},"status":{"type":"string","enum":["pending","failed","ready"]},"design":{"$ref":"#/components/schemas/ResearchDesign3"},"failureDisposition":{"description":"Why a failed design stopped, once its run settled: transient is worth retrying; deterministic and repairable_schema need a changed request.","type":"string","enum":["transient","repairable_schema","deterministic","cancelled","unknown","repairable_domain"]}},"required":["runId","status","design"],"additionalProperties":false},"ResearchStudyDesignsGetResponse":{"type":"object","properties":{"runId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The billing run that pays for the design in Alpha credits."},"status":{"type":"string","enum":["pending","failed","ready"]},"design":{"$ref":"#/components/schemas/ResearchDesign4"},"failureDisposition":{"description":"Why a failed design stopped, once its run settled: transient is worth retrying; deterministic and repairable_schema need a changed request.","type":"string","enum":["transient","repairable_schema","deterministic","cancelled","unknown","repairable_domain"]}},"required":["runId","status","design"],"additionalProperties":false},"ResearchStudyPreviewsGetV3Response":{"type":"object","properties":{"questions":{"type":"array","items":{"$ref":"#/components/schemas/ResearchItem"},"description":"What every respondent is asked, in the order the interviewer asks it."}},"required":["questions"],"additionalProperties":false},"ResearchStudyPreviewsGetV2Response":{"type":"object","properties":{"questions":{"type":"array","items":{"$ref":"#/components/schemas/ResearchInstrumentQuestionsItem"},"description":"What every respondent is asked, in the order the interviewer asks it."}},"required":["questions"],"additionalProperties":false},"ResearchStudyPreviewsGetResponse":{"type":"object","properties":{"questions":{"type":"array","items":{"$ref":"#/components/schemas/ResearchInstrumentQuestionsItem2"},"description":"What every respondent is asked, in the order the interviewer asks it."}},"required":["questions"],"additionalProperties":false},"ResearchInterviewPreviewsStartRequest":{"type":"object","properties":{"campaignName":{"type":"string","minLength":1,"maxLength":120,"description":"The sample's name, e.g. \"Brand health sample interview\"."},"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The business profile whose customer twin is interviewed."},"targetedCustomerIds":{"minItems":1,"maxItems":1,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":"Exactly one customer twin of the profile to interview."},"questions":{"minItems":1,"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/ResearchQuestionsItem"},"description":"The whole edited instrument. The sample skips computer tasks, so the rest must follow a valid route and hold a question to ask. Acceptable use screens each question's prompt, a task's success criteria and website starting site, and each branch rule's meaning whole, so each is at most 2,000 characters (titles, options and file names are shorter by their own bounds), and the study's screened text is at most 160 KiB; nothing is truncated."},"playbookKey":{"type":"string","enum":["ad_copy","brand_health","offers","pricing","product","product_launch","sales","custom","product_roadmap"]},"stimulus":{"$ref":"#/components/schemas/ResearchStimulus"},"researchFocus":{"default":"","type":"string","maxLength":2000,"description":"The study's research focus, screened whole by acceptable use: at most 2,000 characters."},"assumptions":{"description":"Customer assumptions: statements every respondent answers as true of themselves for this study only, beside their own profile, in order; absent or empty when the study states none. Acceptable use screens each whole, so each is at most 2,000 characters, and none is empty.","maxItems":10,"type":"array","items":{"type":"string","maxLength":10000}}},"required":["campaignName","businessProfileId","targetedCustomerIds","questions","playbookKey","stimulus"],"additionalProperties":false},"ResearchInterviewPreviewsStartResponse":{"type":"object","properties":{"runId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The sample's run; read it with research.interview-previews.get.v2."},"status":{"type":"string","enum":["workflow_started","encounter_coordination_required"],"description":"How the sample's run starts."},"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The sample's own campaign, never listed or reported."}},"required":["runId","status","campaignId"],"additionalProperties":false},"ResearchInterviewPreviewsGetV3Response":{"type":"object","properties":{"runId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"status":{"type":"string","enum":["running","succeeded","failed"],"description":"The sample interview's own outcome, not any campaign synthesis."},"customerName":{"type":"string"},"turns":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The question id."},"prompt":{"anyOf":[{"type":"string"},{"type":"null"}]},"answer":{"anyOf":[{"type":"string"},{"type":"null"}]},"attachment":{"description":"The file the question showed the twin, by safe reference.","type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm","audio/mpeg","audio/wav"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":104857600}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false}},"required":["id","prompt","answer"],"additionalProperties":false}}},"required":["runId","status","customerName","turns"],"additionalProperties":false},"ResearchInterviewPreviewsGetV2Response":{"type":"object","properties":{"runId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"status":{"type":"string","enum":["running","succeeded","failed"],"description":"The sample interview's own outcome, not any campaign synthesis."},"customerName":{"type":"string"},"turns":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The question id."},"prompt":{"anyOf":[{"type":"string"},{"type":"null"}]},"answer":{"anyOf":[{"type":"string"},{"type":"null"}]},"attachment":{"description":"The file the question showed the twin, by safe reference.","type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":104857600}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false}},"required":["id","prompt","answer"],"additionalProperties":false}}},"required":["runId","status","customerName","turns"],"additionalProperties":false},"ResearchInterviewPreviewsGetResponse":{"type":"object","properties":{"runId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"status":{"type":"string","enum":["running","succeeded","failed"],"description":"The sample interview's own outcome, not any campaign synthesis."},"customerName":{"type":"string"},"turns":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The question id."},"prompt":{"anyOf":[{"type":"string"},{"type":"null"}]},"answer":{"anyOf":[{"type":"string"},{"type":"null"}]},"attachment":{"description":"The file the question showed the twin, by safe reference.","type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":4194304}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false}},"required":["id","prompt","answer"],"additionalProperties":false}}},"required":["runId","status","customerName","turns"],"additionalProperties":false},"ResearchCampaignsUpdateRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The Research campaign id."},"name":{"type":"string","minLength":1,"maxLength":120,"description":"The campaign's new name."}},"required":["id","name"],"additionalProperties":false,"deprecated":true},"ResearchCampaignsUpdateResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":120}},"required":["id","name"],"additionalProperties":false},"ResearchStudyAttachmentsReserveUploadV4Request":{"type":"object","properties":{"filename":{"type":"string","minLength":1,"maxLength":255,"description":"The file's name as the editor shows it."},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm","audio/mpeg","audio/wav"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":104857600,"description":"Exact size in bytes: a PNG, JPEG or WebP picture at most 3,750,000 bytes, a PDF or an MP3 or WAV audio file at most 4 MiB, a text file at most 256 KB, a video at most 100 MiB."},"sha256":{"description":"Lowercase hex SHA-256 of the exact bytes you will upload. Required for every file but a video, which declares none.","type":"string","pattern":"^[a-f0-9]{64}$"}},"required":["filename","mediaType","byteLength"],"additionalProperties":false},"ResearchStudyAttachmentsReserveUploadV4Response":{"type":"object","properties":{"attachment":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"filename":{"type":"string"},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm","audio/mpeg","audio/wav"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"status":{"type":"string","enum":["pending","ready"],"description":"pending until research.study-attachments.complete-upload.v2 proves the upload."}},"required":["id","filename","mediaType","byteLength","status"],"additionalProperties":false},"upload":{"anyOf":[{"type":"object","properties":{"method":{"type":"string","const":"PUT"},"url":{"type":"string","format":"uri"},"headers":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"expiresAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["method","url","headers","expiresAt"],"additionalProperties":false},{"type":"null"}],"description":"Send the file as the body of exactly this request before expiresAt; the response body is JSON naming the stored file's etag. Null when the file was already uploaded: call research.study-attachments.complete-upload.v2."},"maxBytes":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"The most bytes this file may have."}},"required":["attachment","upload","maxBytes"],"additionalProperties":false},"ResearchStudyAttachmentsReserveUploadV3Request":{"type":"object","properties":{"filename":{"type":"string","minLength":1,"maxLength":255,"description":"The file's name as the editor shows it."},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm","audio/mpeg","audio/wav"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":104857600,"description":"Exact size in bytes: an image or a PDF at most 4 MiB, a text file at most 256 KB, a video at most 100 MiB."},"sha256":{"description":"Lowercase hex SHA-256 of the exact bytes you will upload. Required for every file but a video, which declares none.","type":"string","pattern":"^[a-f0-9]{64}$"}},"required":["filename","mediaType","byteLength"],"additionalProperties":false,"deprecated":true},"ResearchStudyAttachmentsReserveUploadV3Response":{"type":"object","properties":{"attachment":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"filename":{"type":"string"},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm","audio/mpeg","audio/wav"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"status":{"type":"string","enum":["pending","ready"],"description":"pending until research.study-attachments.complete-upload.v2 proves the upload."}},"required":["id","filename","mediaType","byteLength","status"],"additionalProperties":false},"upload":{"anyOf":[{"type":"object","properties":{"method":{"type":"string","const":"PUT"},"url":{"type":"string","format":"uri"},"headers":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"expiresAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["method","url","headers","expiresAt"],"additionalProperties":false},{"type":"null"}],"description":"Send the file as the body of exactly this request before expiresAt; the response body is JSON naming the stored file's etag. Null when the file was already uploaded: call research.study-attachments.complete-upload.v2."},"maxBytes":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"The most bytes this file may have."}},"required":["attachment","upload","maxBytes"],"additionalProperties":false},"ResearchStudyAttachmentsReserveUploadV2Request":{"type":"object","properties":{"filename":{"type":"string","minLength":1,"maxLength":255,"description":"The file's name as the editor shows it."},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":104857600,"description":"Exact size in bytes: an image or a PDF at most 4 MiB, a text file at most 256 KB, a video at most 100 MiB."},"sha256":{"description":"Lowercase hex SHA-256 of the exact bytes you will upload. Required for every file but a video, which declares none.","type":"string","pattern":"^[a-f0-9]{64}$"}},"required":["filename","mediaType","byteLength"],"additionalProperties":false,"deprecated":true},"ResearchStudyAttachmentsReserveUploadV2Response":{"type":"object","properties":{"attachment":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"filename":{"type":"string"},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"status":{"type":"string","enum":["pending","ready"],"description":"pending until research.study-attachments.complete-upload.v2 proves the upload."}},"required":["id","filename","mediaType","byteLength","status"],"additionalProperties":false},"upload":{"anyOf":[{"type":"object","properties":{"method":{"type":"string","const":"PUT"},"url":{"type":"string","format":"uri"},"headers":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"expiresAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["method","url","headers","expiresAt"],"additionalProperties":false},{"type":"null"}],"description":"Send the file as the body of exactly this request before expiresAt; the response body is JSON naming the stored file's etag. Null when the file was already uploaded: call research.study-attachments.complete-upload.v2."},"maxBytes":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"The most bytes this file may have."}},"required":["attachment","upload","maxBytes"],"additionalProperties":false},"ResearchStudyAttachmentsReserveUploadRequest":{"type":"object","properties":{"filename":{"type":"string","minLength":1,"maxLength":255,"description":"The file's name as the editor shows it."},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":4194304,"description":"Exact size in bytes; text files at most 256 KB."},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$","description":"Lowercase hex SHA-256 of the exact bytes you will upload."}},"required":["filename","mediaType","byteLength","sha256"],"additionalProperties":false,"deprecated":true},"ResearchStudyAttachmentsReserveUploadResponse":{"type":"object","properties":{"attachment":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"filename":{"type":"string"},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"status":{"type":"string","enum":["pending","ready"],"description":"pending until research.study-attachments.complete-upload.v1 proves the upload."}},"required":["id","filename","mediaType","byteLength","status"],"additionalProperties":false},"upload":{"anyOf":[{"type":"object","properties":{"method":{"type":"string","const":"PUT"},"url":{"type":"string","format":"uri"},"headers":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"expiresAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["method","url","headers","expiresAt"],"additionalProperties":false},{"type":"null"}],"description":"Send the file as the body of exactly this request before expiresAt; the response body is JSON naming the stored file's etag. Null when the file was already uploaded: call research.study-attachments.complete-upload.v1."},"maxBytes":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"The most bytes this file may have."}},"required":["attachment","upload","maxBytes"],"additionalProperties":false},"ResearchStudyAttachmentsCompleteUploadV3Request":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The attachment id reserve-upload returned."},"etag":{"description":"The etag the upload's response named; omit to recover it from the store.","type":"string","minLength":1,"maxLength":1024}},"required":["id"],"additionalProperties":false},"ResearchStudyAttachmentsCompleteUploadV3Response":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"filename":{"type":"string"},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm","audio/mpeg","audio/wav"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"status":{"type":"string","enum":["pending","ready"],"description":"pending until research.study-attachments.complete-upload.v2 proves the upload."},"storyboard":{"$ref":"#/components/schemas/ResearchStoryboard"}},"required":["id","filename","mediaType","byteLength","status","storyboard"],"additionalProperties":false},"ResearchStudyAttachmentsCompleteUploadV2Request":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The attachment id reserve-upload returned."},"etag":{"description":"The etag the upload's response named; omit to recover it from the store.","type":"string","minLength":1,"maxLength":1024}},"required":["id"],"additionalProperties":false,"deprecated":true},"ResearchStudyAttachmentsCompleteUploadV2Response":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"filename":{"type":"string"},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"status":{"type":"string","enum":["pending","ready"],"description":"pending until research.study-attachments.complete-upload.v2 proves the upload."},"storyboard":{"$ref":"#/components/schemas/ResearchStoryboard"}},"required":["id","filename","mediaType","byteLength","status","storyboard"],"additionalProperties":false},"ResearchStudyAttachmentsCompleteUploadRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The attachment id reserve-upload returned."},"etag":{"description":"The etag the upload's response named; omit to recover it from the store.","type":"string","minLength":1,"maxLength":1024}},"required":["id"],"additionalProperties":false,"deprecated":true},"ResearchStudyAttachmentsCompleteUploadResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"filename":{"type":"string"},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"status":{"type":"string","enum":["pending","ready"],"description":"pending until research.study-attachments.complete-upload.v1 proves the upload."}},"required":["id","filename","mediaType","byteLength","status"],"additionalProperties":false},"ResearchStudyAttachmentsImportLinkRequest":{"type":"object","properties":{"url":{"type":"string","minLength":1,"maxLength":2048,"description":"The link to the file: an image, PDF, audio, text or video file."}},"required":["url"],"additionalProperties":false},"ResearchStudyAttachmentsImportLinkResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"filename":{"type":"string"},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm","audio/mpeg","audio/wav"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"status":{"type":"string","enum":["pending","ready"],"description":"pending until research.study-attachments.complete-upload.v2 proves the upload."},"storyboard":{"$ref":"#/components/schemas/ResearchStoryboard"}},"required":["id","filename","mediaType","byteLength","status","storyboard"],"additionalProperties":false},"ResearchStudyAttachmentsImportConnectedRequest":{"type":"object","properties":{"source":{"type":"string","enum":["google","microsoft","dropbox","figma","canva"],"description":"The connected app: google (Google Drive), microsoft (OneDrive), dropbox, figma or canva."},"ref":{"type":"string","minLength":1,"maxLength":1024,"description":"The item's ref, as alpha_connector_files_list returned it."}},"required":["source","ref"],"additionalProperties":false},"ResearchStudyAttachmentsImportConnectedResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"filename":{"type":"string"},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm","audio/mpeg","audio/wav"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"status":{"type":"string","enum":["pending","ready"],"description":"pending until research.study-attachments.complete-upload.v2 proves the upload."},"storyboard":{"$ref":"#/components/schemas/ResearchStoryboard"}},"required":["id","filename","mediaType","byteLength","status","storyboard"],"additionalProperties":false},"ResearchStudyAttachmentsImportArtifactRequest":{"type":"object","properties":{"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The Studio asset's artifact id."}},"required":["artifactId"],"additionalProperties":false},"ResearchStudyAttachmentsImportArtifactResponse":{"type":"object","properties":{"title":{"type":"string"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ResearchStudyAttachmentsGetV2Response"}}},"required":["title","attachments"],"additionalProperties":false},"ResearchStudyAttachmentSourcesReserveRequest":{"type":"object","properties":{"filename":{"type":"string","minLength":1,"maxLength":255,"description":"The file's name as the editor shows it."},"mediaType":{"type":"string","maxLength":255,"description":"The type the file's sender names it by; its name's extension comes first."},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":524288000,"description":"Exact size in bytes: a picture at most 50 MiB, a video 500 MiB, a sound 200 MiB, a document 100 MiB."}},"required":["filename","mediaType","byteLength"],"additionalProperties":false},"ResearchStudyAttachmentSourcesReserveResponse":{"type":"object","properties":{"source":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Pass it to research.study-attachment-sources.convert.v1."},"filename":{"type":"string"},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","image/gif","image/heic","image/heif","image/avif","image/tiff","image/bmp","image/svg+xml","video/mp4","video/webm","video/quicktime","video/x-m4v","video/x-matroska","video/x-msvideo","video/mpeg","video/3gpp","video/x-ms-wmv","audio/mpeg","audio/wav","audio/mp4","audio/aac","audio/ogg","audio/flac","audio/aiff","audio/webm","audio/x-ms-wma","application/pdf","application/vnd.openxmlformats-officedocument.presentationml.presentation","application/vnd.ms-powerpoint","application/vnd.apple.keynote","application/vnd.oasis.opendocument.presentation","application/vnd.openxmlformats-officedocument.wordprocessingml.document","application/msword","application/vnd.oasis.opendocument.text","application/rtf"],"description":"The type the original is converted from."},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["id","filename","mediaType","byteLength"],"additionalProperties":false},"upload":{"anyOf":[{"type":"object","properties":{"method":{"type":"string","const":"PUT"},"url":{"type":"string","format":"uri"},"headers":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"expiresAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["method","url","headers","expiresAt"],"additionalProperties":false},{"type":"null"}],"description":"Send the file as the body of exactly this request before expiresAt; the response body is JSON naming the stored file's etag. Null when the file was already uploaded: call research.study-attachment-sources.convert.v1."}},"required":["source","upload"],"additionalProperties":false},"ResearchStudyAttachmentSourcesConvertRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The source id reserve returned."},"filename":{"type":"string","minLength":1,"maxLength":255,"description":"The original's name; the study file keeps it with its new extension."}},"required":["id","filename"],"additionalProperties":false},"ResearchStudyAttachmentSourcesConvertResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"filename":{"type":"string"},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm","audio/mpeg","audio/wav"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"status":{"type":"string","enum":["pending","ready"],"description":"pending until research.study-attachments.complete-upload.v2 proves the upload."},"storyboard":{"$ref":"#/components/schemas/ResearchStoryboard"}},"required":["id","filename","mediaType","byteLength","status","storyboard"],"additionalProperties":false},"ResearchStudyAttachmentsGetV2Response":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"filename":{"type":"string"},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm","audio/mpeg","audio/wav"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"status":{"type":"string","enum":["pending","ready"],"description":"pending until research.study-attachments.complete-upload.v2 proves the upload."},"storyboard":{"$ref":"#/components/schemas/ResearchStoryboard"}},"required":["id","filename","mediaType","byteLength","status","storyboard"],"additionalProperties":false},"ResearchStudyAttachmentsGetResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"filename":{"type":"string"},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"status":{"type":"string","enum":["pending","ready"],"description":"pending until research.study-attachments.complete-upload.v2 proves the upload."},"storyboard":{"$ref":"#/components/schemas/ResearchStoryboard"}},"required":["id","filename","mediaType","byteLength","status","storyboard"],"additionalProperties":false},"ResearchStudyAttachmentsDownloadResponse":{"type":"object","properties":{"filename":{"type":"string","minLength":1,"description":"Suggested file name for saving the bytes"},"contentType":{"type":"string","minLength":1},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Short-lived presigned URL that GETs the bytes; null when this deployment cannot sign the object"},"expiresAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}],"description":"When url stops working (minutes after the call); null with url"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["filename","contentType","byteLength","url","expiresAt","id"],"additionalProperties":false},"ExperienceCampaignsStartV3Request":{"type":"object","properties":{"campaignName":{"type":"string","minLength":1,"maxLength":120},"browserDevices":{"description":"The devices every customer shops each page on, each once; each device's visit is one experience run. Absent, desktop and mobile. A nativeApp names mobile alone.","default":["desktop","mobile"],"minItems":1,"maxItems":3,"type":"array","items":{"type":"string","enum":["desktop","mobile","ios_safari"]}},"agents":{"description":"The agents that shop every customer on every page and device, each once (1 to 5). point11 is Point11's own shopper; dots (OpenAI Dots), spark (Gemini Spark), muse (Meta Muse) and grok_bot (Grok Bot) each run the model that vendor's agent most likely uses, in Point11's browser, never as the real agent. Each agent's visit is one experience run at the same price. Absent, point11 alone. A settings Save changes them from the next cycle.","minItems":1,"maxItems":5,"type":"array","items":{"type":"string","enum":["point11","dots","spark","muse","grok_bot"]}},"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customerIds":{"description":"The customers who visit: at least one, and as many as the launch's 1,000 visits hold (each customer visits every page on every device with every agent). Not with follows or stores (locationKeys, locationContexts), which choose them.","minItems":1,"maxItems":30000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"follows":{"$ref":"#/components/schemas/ExperienceFollows"},"locationKeys":{"description":"Instead of customerIds or follows, the business profile's stores whose customers visit (1 to 100): each a location key business_store_profile_summaries_get_v1 lists under businessProfileId; a key that is not one of its stores now is refused. At the launch, every customer at them the launch admits, dealt one per store in the profile's store order until 100, as a followed local Discovery campaign's share is at 1 in 1. They are chosen once and become the campaign's customers; nothing of the stores is recorded.","minItems":1,"maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":500}},"destinationUrls":{"maxItems":25,"type":"array","items":{"type":"string","maxLength":2000,"format":"uri"}},"connectionAccess":{"type":"object","properties":{"connection":{"type":"object","properties":{"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["connectionId","revision"],"additionalProperties":false},"account":{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["accountId","revision"],"additionalProperties":false}},"required":["connection"],"additionalProperties":false},"nativeApp":{"type":"object","properties":{"platform":{"type":"string","enum":["ios","android"]},"buildId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$"},"appId":{"type":"string","minLength":1,"maxLength":255},"versionLabel":{"type":"string","minLength":1,"maxLength":120},"deviceName":{"type":"string","minLength":1,"maxLength":120},"osVersion":{"type":"string","minLength":1,"maxLength":80}},"required":["platform","buildId","sha256","appId","versionLabel","deviceName","osVersion"],"additionalProperties":false},"objective":{"type":"string","minLength":3,"maxLength":2000},"competitorSourceCampaignId":{"description":"A Discovery campaign on the same business profile (discovery_campaigns_list_v1's businessProfileId). Each run, every customer also shops every brand its latest settled conversation there labelled a direct competitor; a customer with none shops the pages alone. Set at launch, never changed. Public websites only: not with connectionAccess or nativeApp.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["campaignName","businessProfileId","destinationUrls","objective"],"additionalProperties":false,"deprecated":true},"ExperienceCampaignsStartV3Response":{"type":"object","properties":{"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"campaignKey":{"type":"string"},"entryId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The campaign entry this launch started: its launch cycle, which every visit of the grid (and of each customer's competitors) belongs to; read its progress with campaigns.campaign-entries.get.v1."},"runUnitCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"delivery":{"type":"string","const":"dispatching"}},"required":["campaignId","campaignKey","entryId","runUnitCount","delivery"],"additionalProperties":false},"ExperienceCampaignsStartV4Request":{"type":"object","properties":{"campaignName":{"type":"string","minLength":1,"maxLength":120},"browserDevices":{"description":"The devices every customer shops each page on, each once; each device's visit is one experience run. Absent, desktop and mobile. A nativeApp names mobile alone.","default":["desktop","mobile"],"minItems":1,"maxItems":3,"type":"array","items":{"type":"string","enum":["desktop","mobile","ios_safari"]}},"agents":{"description":"The agents that shop every customer on every page and device, each once (1 to 5). point11 is Point11's own shopper; dots (OpenAI Dots), spark (Gemini Spark), muse (Meta Muse) and grok_bot (Grok Bot) each run the model that vendor's agent most likely uses, in Point11's browser, never as the real agent. Each agent's visit is one experience run at the same price. Absent, point11 alone. A settings Save changes them from the next cycle.","minItems":1,"maxItems":5,"type":"array","items":{"type":"string","enum":["point11","dots","spark","muse","grok_bot"]}},"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customerIds":{"description":"The customers who visit: at least one, and as many as the launch's 1,000 visits hold (each customer visits every page on every device with every agent). Not with follows or stores (locationKeys, locationContexts), which choose them.","minItems":1,"maxItems":30000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"follows":{"$ref":"#/components/schemas/ExperienceFollows"},"locationKeys":{"description":"Instead of customerIds or follows, the business profile's stores whose customers visit (1 to 100): each a location key business_store_profile_summaries_get_v1 lists under businessProfileId; a key that is not one of its stores now is refused. At the launch, every customer at them the launch admits, dealt one per store in the profile's store order until 100, as a followed local Discovery campaign's share is at 1 in 1. They are chosen once and become the campaign's customers; nothing of the stores is recorded.","minItems":1,"maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":500}},"destinationUrls":{"maxItems":25,"type":"array","items":{"type":"string","maxLength":2000,"format":"uri"}},"connectionAccess":{"type":"object","properties":{"connection":{"type":"object","properties":{"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["connectionId","revision"],"additionalProperties":false},"account":{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["accountId","revision"],"additionalProperties":false}},"required":["connection"],"additionalProperties":false},"nativeApp":{"type":"object","properties":{"platform":{"type":"string","enum":["ios","android"]},"buildId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$"},"appId":{"type":"string","minLength":1,"maxLength":255},"versionLabel":{"type":"string","minLength":1,"maxLength":120},"deviceName":{"type":"string","minLength":1,"maxLength":120},"osVersion":{"type":"string","minLength":1,"maxLength":80}},"required":["platform","buildId","sha256","appId","versionLabel","deviceName","osVersion"],"additionalProperties":false},"objective":{"type":"string","minLength":3,"maxLength":2000},"competitorSourceCampaignId":{"description":"A Discovery campaign on the same business profile (discovery_campaigns_list_v1's businessProfileId). Each run, every customer also shops every brand its latest settled conversation there labelled a direct competitor; a customer with none shops the pages alone. Set at launch, never changed. Public websites only: not with connectionAccess or nativeApp.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"locationContexts":{"$ref":"#/components/schemas/ExperienceLocationContexts"}},"required":["campaignName","businessProfileId","destinationUrls","objective"],"additionalProperties":false},"ExperienceCampaignsStartV4Response":{"type":"object","properties":{"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The campaign: committed when delivery is dispatching; while its stores are set up, the campaign the launch commits once they settle, absent from every campaign read until then, and named by this id for the same Idempotency-Key ever after."},"delivery":{"type":"string","enum":["dispatching","setting_up_stores"],"description":"dispatching: the grid is committed and its units enter Billing's door after the response. setting_up_stores: stores the launch names have no customers yet; each is verified on Google Maps, researched and given its customers, then the campaign commits and shops, any store that could not be set up left out. The member who started it is emailed when a store was left out or the campaign could not start. Nothing is committed until then; a retry under the same Idempotency-Key answers what the setup became."},"campaignKey":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The committed campaign's key; null while setting up stores."},"entryId":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The campaign entry this request started; read its progress with campaigns.campaign-entries.get.v1."},{"type":"null"}],"description":"The campaign entry this launch started: its launch cycle, which every visit of the grid belongs to; read its progress with campaigns.campaign-entries.get.v1. Null while setting up stores."},"runUnitCount":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}],"description":"The units the grid committed; null while setting up stores."},"storeCount":{"anyOf":[{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},{"type":"null"}],"description":"How many stores are being set up; null when dispatching."},"generatedCustomerCount":{"anyOf":[{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},{"type":"null"}],"description":"How many customers their setup generates, 97 at each store as a Discovery campaign's store, included in the plan at no charge; null when dispatching."}},"required":["campaignId","delivery","campaignKey","entryId","runUnitCount","storeCount","generatedCustomerCount"],"additionalProperties":false},"ExperienceCampaignsPrescreenV2Request":{"type":"object","properties":{"mode":{"type":"string","const":"burst"},"campaignName":{"type":"string","minLength":1,"maxLength":120},"browserDevices":{"description":"The devices every customer shops each page on, each once; each device's visit is one experience run. Absent, desktop and mobile. A nativeApp names mobile alone.","default":["desktop","mobile"],"minItems":1,"maxItems":3,"type":"array","items":{"type":"string","enum":["desktop","mobile","ios_safari"]}},"agents":{"description":"The agents that shop every customer on every page and device, each once (1 to 5). point11 is Point11's own shopper; dots (OpenAI Dots), spark (Gemini Spark), muse (Meta Muse) and grok_bot (Grok Bot) each run the model that vendor's agent most likely uses, in Point11's browser, never as the real agent. Each agent's visit is one experience run at the same price. Absent, point11 alone. A settings Save changes them from the next cycle.","minItems":1,"maxItems":5,"type":"array","items":{"type":"string","enum":["point11","dots","spark","muse","grok_bot"]}},"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customerIds":{"description":"The customers who visit: at least one, and as many as the launch's 1,000 visits hold (each customer visits every page on every device with every agent). Not with follows or stores (locationKeys, locationContexts), which choose them.","minItems":1,"maxItems":30000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"follows":{"$ref":"#/components/schemas/ExperienceFollows"},"locationKeys":{"description":"Instead of customerIds or follows, the business profile's stores whose customers visit (1 to 100): each a location key business_store_profile_summaries_get_v1 lists under businessProfileId; a key that is not one of its stores now is refused. At the launch, every customer at them the launch admits, dealt one per store in the profile's store order until 100, as a followed local Discovery campaign's share is at 1 in 1. They are chosen once and become the campaign's customers; nothing of the stores is recorded.","minItems":1,"maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":500}},"destinationUrls":{"maxItems":25,"type":"array","items":{"type":"string","maxLength":2000,"format":"uri"}},"connectionAccess":{"type":"object","properties":{"connection":{"type":"object","properties":{"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["connectionId","revision"],"additionalProperties":false},"account":{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["accountId","revision"],"additionalProperties":false}},"required":["connection"],"additionalProperties":false},"nativeApp":{"type":"object","properties":{"platform":{"type":"string","enum":["ios","android"]},"buildId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$"},"appId":{"type":"string","minLength":1,"maxLength":255},"versionLabel":{"type":"string","minLength":1,"maxLength":120},"deviceName":{"type":"string","minLength":1,"maxLength":120},"osVersion":{"type":"string","minLength":1,"maxLength":80}},"required":["platform","buildId","sha256","appId","versionLabel","deviceName","osVersion"],"additionalProperties":false},"objective":{"type":"string","minLength":3,"maxLength":2000},"competitorSourceCampaignId":{"description":"A Discovery campaign on the same business profile (discovery_campaigns_list_v1's businessProfileId). Each run, every customer also shops every brand its latest settled conversation there labelled a direct competitor; a customer with none shops the pages alone. Set at launch, never changed. Public websites only: not with connectionAccess or nativeApp.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"locationContexts":{"$ref":"#/components/schemas/ExperienceLocationContexts"}},"required":["mode","campaignName","businessProfileId","destinationUrls","objective"],"additionalProperties":false},"ExperienceCampaignsPrescreenV2Response":{"type":"object","properties":{"outcome":{"type":"string","const":"allowed"},"followedCustomerCount":{"anyOf":[{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},{"type":"null"}],"description":"How many of the followed Discovery campaign's customers the launch would shop now, its share; Start chooses them again. Null unless the launch follows a Discovery campaign."},"followedStoreCount":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}],"description":"How many of the followed Discovery campaign's stores the share's customers are at; 0 for a campaign that measures no stores. Null unless the launch follows a Discovery campaign."},"locationCustomerCount":{"anyOf":[{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},{"type":"null"}],"description":"How many customers at the stores locationKeys and locationContexts name the launch would shop, its share of at most 100, the customers its new stores' setup generates included; Start chooses them again. Null unless the launch names stores."},"locationStoreCount":{"anyOf":[{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},{"type":"null"}],"description":"How many of the stores locationKeys and locationContexts name the share's customers are at, its new stores included. Null unless the launch names stores."},"customerGeneration":{"anyOf":[{"type":"object","properties":{"storeCount":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"How many of the stores have no customers yet and are set up."},"customerCount":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"How many customers their setup generates: 97 at each store, as a Discovery campaign sets up a store."},"amountCents":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}],"description":"What those customers cost: always 0, since customer generation is included in the plan and charges nothing."}},"required":["storeCount","customerCount","amountCents"],"additionalProperties":false},{"type":"null"}],"description":"The one-time customer generation the launch's new stores need, included in the plan at no charge. Null unless a store locationContexts names has no customers yet."}},"required":["outcome","followedCustomerCount","followedStoreCount","locationCustomerCount","locationStoreCount","customerGeneration"],"additionalProperties":false},"ExperienceCampaignsUpdateRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The Experience campaign id."},"name":{"type":"string","minLength":1,"maxLength":120,"description":"The campaign's new name."}},"required":["id","name"],"additionalProperties":false,"deprecated":true},"ExperienceCampaignsUpdateResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":120}},"required":["id","name"],"additionalProperties":false},"ExperienceCampaignsGetV3Response":{"type":"object","properties":{"latestEntry":{"$ref":"#/components/schemas/ExperienceLatestEntry"},"campaign":{"$ref":"#/components/schemas/ExperienceCampaign"},"destinations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"url":{"anyOf":[{"type":"string"},{"type":"null"}]},"hostname":{"anyOf":[{"type":"string"},{"type":"null"}]},"isOriginalTarget":{"type":"boolean"}},"required":["id","name","url","hostname","isOriginalTarget"],"additionalProperties":false}},"selectedDestination":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"url":{"anyOf":[{"type":"string"},{"type":"null"}]},"hostname":{"anyOf":[{"type":"string"},{"type":"null"}]},"isOriginalTarget":{"type":"boolean"}},"required":["id","name","url","hostname","isOriginalTarget"],"additionalProperties":false},{"type":"null"}]},"dateScope":{"$ref":"#/components/schemas/ExperienceDateScope"},"results":{"$ref":"#/components/schemas/ExperienceResults"},"scopeEntries":{"type":"array","items":{"type":"object","properties":{"axis":{"type":"string","enum":["customer","store"]},"id":{"type":"string"},"label":{"type":"string","description":"The entry's name, as experience_campaign_segments_get names it"}},"required":["axis","id","label"],"additionalProperties":false},"description":"The read's customer and store segment entries the campaign holds, each with its label, in the order asked. An entry the campaign does not hold is not listed, and narrows the read to nothing. The agent entry is scopeAgent."},"scopeAgent":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","enum":["point11","dots","spark","muse","grok_bot"]},"label":{"type":"string","description":"The agent's brand, as experience_campaign_segments_get names it"}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"The agent entry the read applied: every figure is of that agent's visits alone. Null when the segment scope names no agent: the figures pool every agent's visits, and instrument names each agent's changes"},"competition":{"$ref":"#/components/schemas/ExperienceCompetition"},"metrics":{"type":"object","properties":{"plannedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"finishedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"queuedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"runningCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["plannedCount","finishedCount","queuedCount","runningCount"],"additionalProperties":false},"destinationIcons":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"object","properties":{"url":{"type":"string","description":"The stored favicon: a public object URL"},"tone":{"type":"string","enum":["dark","light","mixed","unknown"]},"transparent":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"needsLightBackplate":{"type":"boolean"},"needsDarkBackplate":{"type":"boolean"}},"required":["url","tone","transparent","needsLightBackplate","needsDarkBackplate"],"additionalProperties":false},"description":"Each website's stored favicon by destinations[].id; one without (no URL, or none stored) is absent and draws its name's initial"},"journeys":{"description":"One page of the campaign's journeys, as experience_journeys_list_v5 answers it, read with the scope; absent unless journeys is set","type":"object","properties":{"data":{"$ref":"#/components/schemas/ExperienceData"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"previousCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"totalCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"pageSize":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["data","nextCursor","previousCursor","totalCount","pageSize"],"additionalProperties":false}},"required":["latestEntry","campaign","destinations","selectedDestination","dateScope","results","scopeEntries","scopeAgent","competition","metrics","destinationIcons"],"additionalProperties":false},"ExperienceCampaignSettingsGetResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The business profile it runs on."},"mode":{"type":"string","enum":["pulse","burst"],"description":"A Burst runs its own customers; a Pulse mirrors a Discovery campaign."},"targetSummary":{"type":"object","properties":{"platforms":{"type":"array","items":{"type":"string","enum":["web","ios","android"]}},"accessModes":{"type":"array","items":{"type":"string","enum":["public","signed_in"]}}},"required":["platforms","accessModes"],"additionalProperties":false,"description":"The platforms and access its targets cover."},"browserDevices":{"type":"array","items":{"type":"string","enum":["desktop","mobile","ios_safari"]},"description":"The devices a browser uses."},"agents":{"type":"array","items":{"type":"string","enum":["point11","dots","spark","muse","grok_bot"]},"description":"The agents each next cycle shops with, every one on every customer, page and device; point11 is Point11's own shopper, every other agent runs its vendor's model in Point11's browser."},"destinations":{"type":"array","items":{"type":"object","properties":{"startUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"connectionAccess":{"anyOf":[{"type":"object","properties":{"connection":{"type":"object","properties":{"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["connectionId","revision"],"additionalProperties":false},"account":{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["accountId","revision"],"additionalProperties":false}},"required":["connection"],"additionalProperties":false},{"type":"null"}]},"nativeApp":{"anyOf":[{"type":"object","properties":{"platform":{"type":"string","enum":["ios","android"]},"buildId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$"},"appId":{"type":"string","minLength":1,"maxLength":255},"versionLabel":{"type":"string","minLength":1,"maxLength":120},"deviceName":{"type":"string","minLength":1,"maxLength":120},"osVersion":{"type":"string","minLength":1,"maxLength":80}},"required":["platform","buildId","sha256","appId","versionLabel","deviceName","osVersion"],"additionalProperties":false},{"type":"null"}]}},"required":["startUrl","connectionAccess","nativeApp"],"additionalProperties":false},"description":"The targets a Burst froze at launch: starting pages, signed-in access, apps."},"objective":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What each customer sets out to do."},"targetedGroupIds":{"anyOf":[{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"type":"null"}],"description":"The audiences it was targeted at; null when not narrowed to audiences."},"targetedCustomerIds":{"anyOf":[{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"type":"null"}],"description":"The customers it was picked from; null when not hand-picked."},"targetedForecastId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The forecast whose customers it runs; null for current customers."},"customerCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The customers a Burst froze at launch."},"customerIds":{"anyOf":[{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"type":"null"}],"description":"An always-on Burst's customer list: the customers its next cycles visit. Null where a Save cannot change the customers: a one-time Burst, one still on the retired weekly or monthly schedule, or a Pulse."},"sourceCampaignId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The Discovery campaign a Pulse mirrors."},"sourceCampaignName":{"anyOf":[{"type":"string"},{"type":"null"}]},"competitorSourceCampaignId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The Discovery campaign, on the same business profile, whose conversations name each customer's direct competitors, which every cycle shops beside the pages; set at launch, never by a Save. Null when the campaign shops its pages alone, and on a Pulse."},"competitorSourceCampaignName":{"anyOf":[{"type":"string"},{"type":"null"}]},"followedCampaignId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The Discovery campaign a Burst follows for its customers: each scheduled cycle it plans re-reads that campaign's roster, so a customer who left it leaves, each store the list no longer covers lends its share up to 100, and a Save changes no customers. Set at launch, never by a Save. Null when the campaign records no follow."},"followedCampaignName":{"anyOf":[{"type":"string"},{"type":"null"}]},"followedCampaignStatus":{"anyOf":[{"type":"string","enum":["active","paused","archived","deleted"]},{"type":"null"}],"description":"The followed campaign's lifecycle. While it is archived the Burst keeps the customer list it last read, and a restore resumes the follow at the next scheduled cycle; once it is deleted the list stays for good."},"pulseCompetitors":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether a Pulse also shops the competitors Discovery showed each customer; null for a Burst."},"pulseSampleEvery":{"anyOf":[{"type":"integer","minimum":1,"maximum":20},{"type":"null"}],"description":"A Pulse mirrors 1 in this many of each source dispatch's Discovery conversations; 1 is every one. Null for a Burst."},"customerVersions":{"anyOf":[{"type":"object","properties":{"policy":{"type":"string","enum":["pinned","latest"],"description":"Always latest: every new cycle uses each customer's newest version. pinned is no longer a choice."},"locked":{"anyOf":[{"type":"string","enum":["pulse_follows_discovery"]},{"type":"null"}],"description":"Always null: there is no policy left to change."},"newerCustomerCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Always 0: no customer has a newer version than the one its next cycle uses."}},"required":["policy","locked","newerCustomerCount"],"additionalProperties":false},{"type":"null"}],"description":"Which customer versions its next cycles use: each customer's newest, at every new cycle, while running work keeps its version. Null for a Burst that plans no next cycle: a one-time one, or one still on the retired weekly or monthly schedule."},"settingsRevision":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Its settings revision: pass it as expectedSettingsRevision to experience.campaign-settings-quotes.get and experience.campaign-settings.update."}},"required":["id","businessProfileId","mode","targetSummary","browserDevices","agents","destinations","objective","targetedGroupIds","targetedCustomerIds","targetedForecastId","customerCount","customerIds","sourceCampaignId","sourceCampaignName","competitorSourceCampaignId","competitorSourceCampaignName","followedCampaignId","followedCampaignName","followedCampaignStatus","pulseCompetitors","pulseSampleEvery","customerVersions","settingsRevision"],"additionalProperties":false},"ExperienceCampaignSettingsQuotesGetResponse":{"type":"object","properties":{"settingsRevision":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The settings revision this quote read; pass it as expectedSettingsRevision."},"requiresReview":{"type":"boolean","description":"Whether the Save changes money or results, so Billing is asked about its work and a quoted estimate is re-checked; false when it changes only the name."},"changes":{"$ref":"#/components/schemas/DiscoveryChanges"},"estimate":{"$ref":"#/components/schemas/DiscoveryEstimate"},"billing":{"oneOf":[{"type":"object","properties":{"outcome":{"type":"string","const":"not_needed"}},"required":["outcome"],"additionalProperties":false},{"type":"object","properties":{"outcome":{"type":"string","const":"admitted"}},"required":["outcome"],"additionalProperties":false},{"type":"object","properties":{"outcome":{"type":"string","const":"refused"},"reason":{"type":"string","minLength":1,"description":"Billing's refusal reason."},"message":{"type":"string","minLength":1,"description":"Billing's refusal, in its own words."},"paymentDisputeHold":{"type":"boolean","description":"Whether the account is held for a payment dispute, which a new card does not lift."}},"required":["outcome","reason","message","paymentDisputeHold"],"additionalProperties":false}]},"resultsNote":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"How the change reaches results; null when results do not change."},"reviewedEstimate":{"anyOf":[{"type":"object","properties":{"monthlyAfter":{"type":"integer","minimum":0,"maximum":9007199254740991},"unitPriceCents":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"oneTimeAmountCents":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]}},"required":["monthlyAfter","unitPriceCents","oneTimeAmountCents"],"additionalProperties":false,"description":"The estimate a quote returned (its reviewedEstimate): the Save is refused if it moved. Null saves at the current estimate."},{"type":"null"}],"description":"Pass to the update as reviewedEstimate; null when there is no estimate."}},"required":["settingsRevision","requiresReview","changes","estimate","billing","resultsNote","reviewedEstimate"],"additionalProperties":false},"ExperienceCampaignSettingsUpdateRequest":{"type":"object","properties":{"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The campaign's id."},"expectedSettingsRevision":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The settingsRevision the settings read (or a quote) returned."},"reviewedEstimate":{"anyOf":[{"type":"object","properties":{"monthlyAfter":{"type":"integer","minimum":0,"maximum":9007199254740991},"unitPriceCents":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"oneTimeAmountCents":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]}},"required":["monthlyAfter","unitPriceCents","oneTimeAmountCents"],"additionalProperties":false,"description":"The estimate a quote returned (its reviewedEstimate): the Save is refused if it moved. Null saves at the current estimate."},{"type":"null"}]},"changes":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120,"description":"The campaign's new name."},"browserDevices":{"description":"The devices each next cycle visits on: the whole set, at least one.","minItems":1,"maxItems":3,"type":"array","items":{"type":"string","enum":["desktop","mobile","ios_safari"]}},"agents":{"description":"The agents that shop every next cycle, each on every customer, page and device: the whole set, at least one. point11 is Point11's own shopper; the others run the model their vendor's agent most likely uses, in Point11's browser. An added agent starts with the next cycle; a cycle already planned keeps its agents. A Mirror (Pulse) shops with point11 alone.","minItems":1,"maxItems":5,"type":"array","items":{"type":"string","enum":["point11","dots","spark","muse","grok_bot"]}},"addCustomerIds":{"description":"Customers the next cycles also visit with.","maxItems":30000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"removeCustomerIds":{"description":"Customers taken off the list: they stop at once, even in a cycle already planned, and their past visits stay.","maxItems":30000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"customerVersionPolicy":{"description":"Every new cycle uses each customer's newest version, so `latest` changes nothing. `pinned` is no longer a choice: 409 PRECONDITION_FAILED, details.reason invalid_change, details.field customerVersionPolicy.","type":"string","enum":["pinned","latest"]}},"additionalProperties":false}},"required":["campaignId","expectedSettingsRevision","reviewedEstimate","changes"],"additionalProperties":false},"ExperienceCampaignSettingsUpdateResponse":{"type":"object","properties":{"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"changed":{"type":"boolean","description":"False when the Save asked for the settings the campaign has."},"settingsRevision":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The campaign's revision now."},"changes":{"$ref":"#/components/schemas/DiscoveryChanges2"}},"required":["campaignId","changed","settingsRevision","changes"],"additionalProperties":false},"ExperienceCampaignAnalyticsGetV9Response":{"type":"object","properties":{"latestEntry":{"$ref":"#/components/schemas/ExperienceLatestEntry"},"campaign":{"$ref":"#/components/schemas/ExperienceCampaign"},"destinations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"url":{"anyOf":[{"type":"string"},{"type":"null"}]},"hostname":{"anyOf":[{"type":"string"},{"type":"null"}]},"isOriginalTarget":{"type":"boolean"}},"required":["id","name","url","hostname","isOriginalTarget"],"additionalProperties":false}},"selectedDestination":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"url":{"anyOf":[{"type":"string"},{"type":"null"}]},"hostname":{"anyOf":[{"type":"string"},{"type":"null"}]},"isOriginalTarget":{"type":"boolean"}},"required":["id","name","url","hostname","isOriginalTarget"],"additionalProperties":false},{"type":"null"}]},"dateScope":{"$ref":"#/components/schemas/ExperienceDateScope"},"results":{"$ref":"#/components/schemas/ExperienceResults"},"scopeEntries":{"type":"array","items":{"type":"object","properties":{"axis":{"type":"string","enum":["customer","store"]},"id":{"type":"string"},"label":{"type":"string","description":"The entry's name, as experience_campaign_segments_get names it"}},"required":["axis","id","label"],"additionalProperties":false},"description":"The read's customer and store segment entries the campaign holds, each with its label, in the order asked. An entry the campaign does not hold is not listed, and narrows the read to nothing. The agent entry is scopeAgent."},"scopeAgent":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","enum":["point11","dots","spark","muse","grok_bot"]},"label":{"type":"string","description":"The agent's brand, as experience_campaign_segments_get names it"}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"The agent entry the read applied: every figure is of that agent's visits alone. Null when the segment scope names no agent: the figures pool every agent's visits, and instrument names each agent's changes"},"competition":{"$ref":"#/components/schemas/ExperienceCompetition"},"metrics":{"type":"object","properties":{"plannedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"finishedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"queuedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"runningCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"limitedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"scoredCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"passedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"failedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"experienceScore":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"A roll-up over these visits, never a visit's own figure: passRate times the points averageQualityStars earns; null when nothing was judged, or when passes carry no star rating"},"passRate":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Site pass rate, %: met journeys over the window's journeys less failures the evaluator blamed on the shopper; null when there are none"},"shopperExcludedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"siteFailureRate":{"anyOf":[{"type":"number"},{"type":"null"}]},"topBoxRate":{"anyOf":[{"type":"number"},{"type":"null"}]},"eligibleCustomers":{"type":"integer","minimum":0,"maximum":9007199254740991},"passCustomers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct customers behind passRate's journeys: the sample it stands on"},"earlierPassCustomers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The same over the 30 days before results.asOf, which changes.passRate compares with"},"averageQualityStars":{"anyOf":[{"type":"number"},{"type":"null"}]},"qualityRatedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"ratedCustomers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct customers behind the rated journeys averageQualityStars is the mean of"},"coverage":{"type":"object","properties":{"measured":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Interactions: visits whose scorer gave a verdict (pass or fail), the journeys every rate is over"},"couldNotTell":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Visits the scorer could not tell for a reason other than blocked (policy, infrastructure, cut short, does not apply); in no rate"},"blocked":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Visits the scorer could not tell because a bot wall, CAPTCHA, access-denied page or login stopped them; in no rate"}},"required":["measured","couldNotTell","blocked"],"additionalProperties":false,"description":"The website's evaluated visits in the as-of window: the measured ones every rate stands on, and those no rate counts"},"changes":{"type":"object","properties":{"experienceScore":{"anyOf":[{"type":"number"},{"type":"null"}]},"passRate":{"anyOf":[{"type":"number"},{"type":"null"}]},"siteFailureRate":{"anyOf":[{"type":"number"},{"type":"null"}]},"topBoxRate":{"anyOf":[{"type":"number"},{"type":"null"}]},"averageQualityStars":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["experienceScore","passRate","siteFailureRate","topBoxRate","averageQualityStars"],"additionalProperties":false,"description":"Each figure minus its value 30 days before results.asOf, in points (stars for averageQualityStars); null unless both days measured it"},"trends":{"type":"object","properties":{"experienceScore":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"UTC day; the value is its trailing 30-day window's."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Null where that window holds no interaction."}},"required":["day","value"],"additionalProperties":false}},"passRate":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"UTC day; the value is its trailing 30-day window's."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Null where that window holds no interaction."}},"required":["day","value"],"additionalProperties":false}},"averageQualityStars":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"UTC day; the value is its trailing 30-day window's."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Null where that window holds no interaction."}},"required":["day","value"],"additionalProperties":false}}},"required":["experienceScore","passRate","averageQualityStars"],"additionalProperties":false,"description":"One point per day from results.from to results.to"}},"required":["plannedCount","finishedCount","queuedCount","runningCount","limitedCount","scoredCount","passedCount","failedCount","experienceScore","passRate","shopperExcludedCount","siteFailureRate","topBoxRate","eligibleCustomers","passCustomers","earlierPassCustomers","averageQualityStars","qualityRatedCount","ratedCustomers","coverage","changes","trends"],"additionalProperties":false},"segments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"journeyCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"passedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"failedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"shopperExcludedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"qualityRatedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"passRate":{"anyOf":[{"type":"number"},{"type":"null"}]},"averageQualityStars":{"anyOf":[{"type":"number"},{"type":"null"}]},"experienceScore":{"anyOf":[{"type":"number"},{"type":"null"}]},"eligibleCustomers":{"type":"integer","minimum":0,"maximum":9007199254740991},"passCustomers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct customers behind the row's pass rate: the sample it stands on"},"earlierPassCustomers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The same over the 30 days before results.asOf, which passRateChange compares with"},"passRateChange":{"anyOf":[{"type":"number"},{"type":"null"}]},"experienceScoreChange":{"anyOf":[{"type":"number"},{"type":"null"}]},"vsTotalsPts":{"anyOf":[{"type":"number"},{"type":"null"}]},"experienceScoreVsTotalsPts":{"anyOf":[{"type":"number"},{"type":"null"}]},"coverage":{"anyOf":[{"type":"object","properties":{"measured":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Interactions: visits whose scorer gave a verdict (pass or fail), the journeys every rate is over"},"couldNotTell":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Visits the scorer could not tell for a reason other than blocked (policy, infrastructure, cut short, does not apply); in no rate"},"blocked":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Visits the scorer could not tell because a bot wall, CAPTCHA, access-denied page or login stopped them; in no rate"}},"required":["measured","couldNotTell","blocked"],"additionalProperties":false,"description":"The website's evaluated visits in the as-of window: the measured ones every rate stands on, and those no rate counts"},{"type":"null"}],"description":"On the overview and competitors tabs, whose rows are websites, the row's coverage; a website every visit of which the scorer could not tell is a row with no figure. Null on every other tab, whose website's coverage is metrics.coverage"}},"required":["id","label","journeyCount","passedCount","failedCount","shopperExcludedCount","qualityRatedCount","passRate","averageQualityStars","experienceScore","eligibleCustomers","passCustomers","earlierPassCustomers","passRateChange","experienceScoreChange","vsTotalsPts","experienceScoreVsTotalsPts","coverage"],"additionalProperties":false}},"drivers":{"type":"array","items":{"type":"object","properties":{"segmentId":{"type":"string"},"against":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"On the overview tab, for the campaign's own website: the competitor (a destinations id) whose matched pairs this reason is counted over; null for the row's own journeys"},"kind":{"type":"string","enum":["win","loss"]},"key":{"type":"string"},"label":{"type":"string"},"count":{"type":"integer","minimum":0,"maximum":9007199254740991},"eligibleCustomers":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["segmentId","against","kind","key","label","count","eligibleCustomers"],"additionalProperties":false},"description":"Why journeys passed and failed, per breakdown row, as of results.asOf: a win counts the row's passed journeys that carried a strength that issue grouping named from the reasons the scorer said helped them (key strength:<label>), a loss its failed journeys that carried an issue that issue grouping named from their frictions and the reasons that hurt them (key issue:<label>); findings no grouping run has grouped yet count as Not grouped yet (key ungrouped:strength or ungrouped:issue), a visit scored before the scorer named reasons carries no strength, and a failure blamed on the shopper is no loss. On the overview and competitors tabs a row is a website, its own journeys; on the overview the campaign's own website is also counted against each competitor over their matched pairs (against), a win where its visit beat theirs (a pass over a failure, or more stars) and a loss where theirs beat it"},"failures":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","enum":["site","shopper","external"]},"count":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["key","count"],"additionalProperties":false}},"stars":{"type":"array","items":{"type":"object","properties":{"stars":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"count":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["stars","count"],"additionalProperties":false}},"series":{"type":"object","properties":{"segments":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"UTC day; the value is its trailing 30-day window's."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Null where that window holds no interaction."}},"required":["day","value"],"additionalProperties":false}},"description":"Each breakdown row's Experience Score, one point per day of the range"},"segmentCounts":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"UTC day; the value is its trailing 30-day window's."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Null where that window holds no interaction."}},"required":["day","value"],"additionalProperties":false},"description":"How many rows each day's window measured"}},"required":["segments","segmentCounts"],"additionalProperties":false},"instrument":{"type":"object","properties":{"changes":{"$ref":"#/components/schemas/ExperienceChanges"},"comparable":{"type":"boolean","description":"No change falls between the start of the window ending results.comparedTo and results.asOf, so every change compares like with like; false: the changes span an instrument change and no significance is claimed for them"}},"required":["changes","comparable"],"additionalProperties":false},"destinationIcons":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"object","properties":{"url":{"type":"string","description":"The stored favicon: a public object URL"},"tone":{"type":"string","enum":["dark","light","mixed","unknown"]},"transparent":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"needsLightBackplate":{"type":"boolean"},"needsDarkBackplate":{"type":"boolean"}},"required":["url","tone","transparent","needsLightBackplate","needsDarkBackplate"],"additionalProperties":false},"description":"Each website's stored favicon by destinations[].id; one without (no URL, or none stored) is absent and draws its name's initial"},"panels":{"anyOf":[{"type":"object","properties":{"customerLocations":{"$ref":"#/components/schemas/ExperienceCustomerLocations"},"replayJourneys":{"$ref":"#/components/schemas/ExperienceReplayJourneys"}},"required":["customerLocations","replayJourneys"],"additionalProperties":false},{"type":"null"}]},"revenueValue":{"anyOf":[{"$ref":"#/components/schemas/ExperienceRevenueValue"},{"type":"null"}],"description":"Experience dollars: the campaign's own website against the competitors its customers also shopped, over the pairs dated in the as-of window, by product (revenue line) and added up, a plus or minus. Read on the overview and revenue tabs (the dashboard's Overview and Products) for the campaign's own website; null on any other tab or website, for a campaign that shops no competitor, and while no customer was judged on both"},"revenueValueTrend":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"UTC day; the value is its trailing 30-day window's."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Null where that window holds no interaction."}},"required":["day","value"],"additionalProperties":false},"description":"On the overview tab, revenueValue's experienceUsd per day from results.from to results.to, each day's own 30-day window valued by the same formula at each line's point in revenueValue; null where it values nothing. Empty on every other tab and wherever revenueValue is not read"},"revenueValueChange":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"On the overview tab, revenueValue's experienceUsd less its value 30 days before results.asOf; null unless both days value something"}},"required":["latestEntry","campaign","destinations","selectedDestination","dateScope","results","scopeEntries","scopeAgent","competition","metrics","segments","drivers","failures","stars","series","instrument","destinationIcons","panels","revenueValue","revenueValueTrend","revenueValueChange"],"additionalProperties":false},"ExperienceBrandMapsGetV4Response":{"type":"object","properties":{"latestEntry":{"$ref":"#/components/schemas/ExperienceLatestEntry"},"campaign":{"$ref":"#/components/schemas/ExperienceCampaign"},"destinations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"url":{"anyOf":[{"type":"string"},{"type":"null"}]},"hostname":{"anyOf":[{"type":"string"},{"type":"null"}]},"isOriginalTarget":{"type":"boolean"}},"required":["id","name","url","hostname","isOriginalTarget"],"additionalProperties":false}},"selectedDestination":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"url":{"anyOf":[{"type":"string"},{"type":"null"}]},"hostname":{"anyOf":[{"type":"string"},{"type":"null"}]},"isOriginalTarget":{"type":"boolean"}},"required":["id","name","url","hostname","isOriginalTarget"],"additionalProperties":false},{"type":"null"}]},"dateScope":{"$ref":"#/components/schemas/ExperienceDateScope"},"results":{"$ref":"#/components/schemas/ExperienceResults"},"scopeEntries":{"type":"array","items":{"type":"object","properties":{"axis":{"type":"string","enum":["customer","store"]},"id":{"type":"string"},"label":{"type":"string","description":"The entry's name, as experience_campaign_segments_get names it"}},"required":["axis","id","label"],"additionalProperties":false},"description":"The read's customer and store segment entries the campaign holds, each with its label, in the order asked. An entry the campaign does not hold is not listed, and narrows the read to nothing. The agent entry is scopeAgent."},"scopeAgent":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","enum":["point11","dots","spark","muse","grok_bot"]},"label":{"type":"string","description":"The agent's brand, as experience_campaign_segments_get names it"}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"The agent entry the read applied: every figure is of that agent's visits alone. Null when the segment scope names no agent: the figures pool every agent's visits, and instrument names each agent's changes"},"competition":{"$ref":"#/components/schemas/ExperienceCompetition"},"metrics":{"type":"object","properties":{"plannedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"finishedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"queuedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"runningCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["plannedCount","finishedCount","queuedCount","runningCount"],"additionalProperties":false},"destinationIcons":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"object","properties":{"url":{"type":"string","description":"The stored favicon: a public object URL"},"tone":{"type":"string","enum":["dark","light","mixed","unknown"]},"transparent":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"needsLightBackplate":{"type":"boolean"},"needsDarkBackplate":{"type":"boolean"}},"required":["url","tone","transparent","needsLightBackplate","needsDarkBackplate"],"additionalProperties":false},"description":"Each website's stored favicon by destinations[].id; one without (no URL, or none stored) is absent and draws its name's initial"},"map":{"anyOf":[{"type":"object","properties":{"datasetKey":{"type":"string","description":"Names what the map was read from: the campaign, website, the day its results window is as of with the interactions it holds, and the segment scope. experience.competitor-reasons.get answers the same key while it describes the same map"},"website":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false,"description":"The campaign's own website, which the map is always read for"},"experienceScore":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The website's Experience Score over every journey judged on it: experience.campaign-analytics.get's figure for the same scope"},"judgedJourneys":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The journeys that score stands on: the pass rate's denominator"},"value":{"anyOf":[{"$ref":"#/components/schemas/ExperienceRevenueValue"},{"type":"null"}],"description":"The website against every competitor: the one gap stated for them all (gapPts) and its Experience dollars by product (revenue line) and added up; the competitors' experienceUsd add up to its total. Without market assumptions in Tools › Products it states the gap and no dollars. Null when no customer was judged on both"},"sizedBy":{"type":"string","enum":["usd","journeys"],"description":"The unit of every size: usd (the size of experienceUsd, whichever way it points) when any match has dollars, else matched pairs"},"competitors":{"type":"array","items":{"$ref":"#/components/schemas/ExperienceCompetitorsItem"},"description":"From the competitor the website leads by most to the one that leads it by most, then those with no gap to state"},"shopsCompetitors":{"type":"boolean","description":"Discovery named a competitor for the campaign, ready to shop or not: with competitors empty, whether its pairs have yet to match or the campaign has none to match"},"coverage":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The website's id, as destinations[].id names it"},"measured":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Interactions in the as-of window: visits whose scorer gave a verdict"},"couldNotTell":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Visits the scorer could not tell for a reason other than blocked; in no pair"},"blocked":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Visits the scorer could not tell because a bot wall, CAPTCHA, access-denied page or login stopped them; in no pair"}},"required":["id","measured","couldNotTell","blocked"],"additionalProperties":false},"description":"What each website the map sets side by side stands on in the as-of window: the campaign's own and every competitor Discovery named, matched or not, so a competitor that walls off the shopper reads as blocked beside the pairs it left"},"instrument":{"type":"object","properties":{"changes":{"$ref":"#/components/schemas/ExperienceChanges"},"comparable":{"type":"boolean","description":"No change falls between the start of the window ending results.comparedTo and results.asOf, so every change compares like with like; false: the changes span an instrument change and no significance is claimed for them"}},"required":["changes","comparable"],"additionalProperties":false,"description":"The instrument changes among the as-of window's interactions the map pools; each marks every figure on it"}},"required":["datasetKey","website","experienceScore","judgedJourneys","value","sizedBy","competitors","shopsCompetitors","coverage","instrument"],"additionalProperties":false},{"type":"null"}],"description":"Null while the scope holds no interaction, and for a campaign with no single website of its own: one that measures no site and tests several pages"}},"required":["latestEntry","campaign","destinations","selectedDestination","dateScope","results","scopeEntries","scopeAgent","competition","metrics","destinationIcons","map"],"additionalProperties":false},"ExperienceBrandMatchupsGetV3Response":{"type":"object","properties":{"datasetKey":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Names what the matchup was read from, as experience.brand-maps.get's map.datasetKey does: equal while both describe the same window, website and segment scope. Null when the scope holds no interaction or website to read"},"matchup":{"anyOf":[{"type":"object","properties":{"competitor":{"anyOf":[{"$ref":"#/components/schemas/ExperienceCompetitorsItem"},{"type":"null"}],"description":"Null when no customer was judged on both websites"},"sizedBy":{"type":"string","enum":["usd","journeys"],"description":"The unit of every size: usd (the size of experienceUsd, whichever way it points) when any match has dollars, else matched pairs"},"lines":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"matchedPairs":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Matched pairs: one visit to the campaign's website and the same customer's visit to the competitor's in the same cycle, on the same device. Against one competitor a pair is one journey of the campaign's website"},"customers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct customers behind the matched pairs"},"wins":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The matched pairs the campaign's website won: its journey passed and the competitor's failed, or both passed and its journey earned more stars"},"losses":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The matched pairs the competitor won, by the same rule. The rest decide nothing (both failed, equal stars, a pass with no stars, or a failure blamed on the shopper), so wins plus losses can be fewer than matchedPairs, and the record can point the other way from gapPts"},"ours":{"type":"object","properties":{"experienceScore":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The Experience Score of this side of the matched pairs, 0 to 100, valued as experience.campaign-analytics.get values a segment's; null when it has none to claim"},"passRatePct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The site pass rate over this side of the matched pairs, 0 to 100"},"averageStars":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Mean stars over this side's rated journeys in the matched pairs"},"judgedJourneys":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"This side's journeys in the pass rate's denominator: all but the failures blamed on the shopper"}},"required":["experienceScore","passRatePct","averageStars","judgedJourneys"],"additionalProperties":false,"description":"The campaign's own website over the matched pairs only, so it can differ from the website's own score"},"theirs":{"type":"object","properties":{"experienceScore":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The Experience Score of this side of the matched pairs, 0 to 100, valued as experience.campaign-analytics.get values a segment's; null when it has none to claim"},"passRatePct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The site pass rate over this side of the matched pairs, 0 to 100"},"averageStars":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Mean stars over this side's rated journeys in the matched pairs"},"judgedJourneys":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"This side's journeys in the pass rate's denominator: all but the failures blamed on the shopper"}},"required":["experienceScore","passRatePct","averageStars","judgedJourneys"],"additionalProperties":false},"gapPts":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Our score less theirs, in points; null unless both sides have a score"},"experienceUsd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The match's Experience dollars, plus or minus: a competitor's across the business's products, its revenue lines (its parts of the lines added up, so their sign can differ from gapPts's), or a line's against one competitor; null without a worth or a gap to value"},"valuedPairs":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The matched pairs experienceUsd stands on: a competitor's on the products (revenue lines) with a worth, which can be fewer than matchedPairs; a line's own. 0 without dollars"},"valuedCustomers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct customers behind valuedPairs: the sample the dollars' precision reads, as customers is the gap's. 0 without dollars"},"size":{"type":"number","minimum":0,"description":"What the match weighs on the map, in sizedBy's unit"}},"required":["id","label","matchedPairs","customers","wins","losses","ours","theirs","gapPts","experienceUsd","valuedPairs","valuedCustomers","size"],"additionalProperties":false},"description":"The match cut by the product (revenue line) of the website's own customers, most matched pairs first"},"lostHereJourneys":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Journeys dated in the 30 days ending with results.asOf that failed on the campaign's website (not counting a failure blamed on the shopper) while the same customer's goal passed on the competitor's: never fewer than lostHere lists"},"lostHere":{"type":"array","items":{"type":"object","properties":{"runId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The failed journey on the campaign's website"},"competitorRunId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The passed journey on the competitor's"},"customerName":{"type":"string"},"device":{"type":"string"}},"required":["runId","competitorRunId","customerName","device"],"additionalProperties":false},"description":"The first of those journeys by customer name, each with its two replays"}},"required":["competitor","sizedBy","lines","lostHereJourneys","lostHere"],"additionalProperties":false},{"type":"null"}],"description":"Null when the scope holds no interaction or website to read"}},"required":["datasetKey","matchup"],"additionalProperties":false},"ExperienceCompetitorReasonsGetV2Response":{"type":"object","properties":{"datasetKey":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Names what the reasons were read from, as experience.brand-maps.get's map.datasetKey does: equal while both describe the same window, website and segment scope. Null when the scope holds no interaction or website to read"},"reasons":{"anyOf":[{"type":"object","properties":{"competitor":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},"win":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"strength:<label> or issue:<label> for what issue grouping recorded, ungrouped:strength or ungrouped:issue for what no grouping run has grouped yet, as experience.campaign-analytics.get.v9's drivers are keyed"},"label":{"type":"string"},"pairs":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The pairs that went to this side carrying it"},"customers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct customers behind those pairs"}},"required":["key","label","pairs","customers"],"additionalProperties":false},"description":"Why the website won its pairs with the competitor, most pairs first"},"loss":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"strength:<label> or issue:<label> for what issue grouping recorded, ungrouped:strength or ungrouped:issue for what no grouping run has grouped yet, as experience.campaign-analytics.get.v9's drivers are keyed"},"label":{"type":"string"},"pairs":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The pairs that went to this side carrying it"},"customers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct customers behind those pairs"}},"required":["key","label","pairs","customers"],"additionalProperties":false},"description":"Why the website lost its pairs with the competitor, most pairs first"}},"required":["competitor","win","loss"],"additionalProperties":false},{"type":"null"}],"description":"Null when the scope holds no interaction or website to read"}},"required":["datasetKey","reasons"],"additionalProperties":false},"ExperienceMatrixMapsGetV4Response":{"type":"object","properties":{"latestEntry":{"$ref":"#/components/schemas/ExperienceLatestEntry"},"campaign":{"$ref":"#/components/schemas/ExperienceCampaign"},"destinations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"url":{"anyOf":[{"type":"string"},{"type":"null"}]},"hostname":{"anyOf":[{"type":"string"},{"type":"null"}]},"isOriginalTarget":{"type":"boolean"}},"required":["id","name","url","hostname","isOriginalTarget"],"additionalProperties":false}},"selectedDestination":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"url":{"anyOf":[{"type":"string"},{"type":"null"}]},"hostname":{"anyOf":[{"type":"string"},{"type":"null"}]},"isOriginalTarget":{"type":"boolean"}},"required":["id","name","url","hostname","isOriginalTarget"],"additionalProperties":false},{"type":"null"}]},"dateScope":{"$ref":"#/components/schemas/ExperienceDateScope"},"results":{"$ref":"#/components/schemas/ExperienceResults"},"scopeEntries":{"type":"array","items":{"type":"object","properties":{"axis":{"type":"string","enum":["customer","store"]},"id":{"type":"string"},"label":{"type":"string","description":"The entry's name, as experience_campaign_segments_get names it"}},"required":["axis","id","label"],"additionalProperties":false},"description":"The read's customer and store segment entries the campaign holds, each with its label, in the order asked. An entry the campaign does not hold is not listed, and narrows the read to nothing. The agent entry is scopeAgent."},"scopeAgent":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","enum":["point11","dots","spark","muse","grok_bot"]},"label":{"type":"string","description":"The agent's brand, as experience_campaign_segments_get names it"}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"The agent entry the read applied: every figure is of that agent's visits alone. Null when the segment scope names no agent: the figures pool every agent's visits, and instrument names each agent's changes"},"competition":{"$ref":"#/components/schemas/ExperienceCompetition"},"metrics":{"type":"object","properties":{"plannedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"finishedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"queuedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"runningCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["plannedCount","finishedCount","queuedCount","runningCount"],"additionalProperties":false},"map":{"anyOf":[{"type":"object","properties":{"datasetKey":{"type":"string","description":"Names the campaign, website, the day its results window is as of with the interactions it holds, and the segment scope the map was read for"},"competitorSourceCampaignId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The Discovery campaign the campaign reads its competitors from, whose Products and Audiences reports hold how often AI recommends the brand for each segment; null when it names none the organization still holds"},"matchedPairs":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Matched pairs behind the whole map: one per journey of ours and the same customer's on one competitor's website"},"websites":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The website's id, as destinations[].id names it"},"name":{"type":"string","description":"The website's name; a competitor's is its brand's in the Discovery campaign competitorSourceCampaignId names, as discovery_competitor_reports_get_v5's competitors[].name names it"},"own":{"type":"boolean","description":"The campaign's own website; every other is a competitor's"},"experienceScore":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The website's Experience Score over every journey judged on it in the window, 0 to 100, as experience.campaign-analytics.get states it; null where they leave none to claim"},"passRatePct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The site pass rate over the same journeys, 0 to 100; null with none"},"judgedJourneys":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The journeys judged on it: the pass rate's denominator"},"coverage":{"type":"object","properties":{"measured":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Interactions: visits whose scorer gave a verdict (pass or fail), the journeys every rate is over"},"couldNotTell":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Visits the scorer could not tell for a reason other than blocked (policy, infrastructure, cut short, does not apply); in no rate"},"blocked":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Visits the scorer could not tell because a bot wall, CAPTCHA, access-denied page or login stopped them; in no rate"}},"required":["measured","couldNotTell","blocked"],"additionalProperties":false,"description":"The website's evaluated visits in the as-of window: the measured ones every rate stands on, and those no rate counts"}},"required":["id","name","own","experienceScore","passRatePct","judgedJourneys","coverage"],"additionalProperties":false},"description":"Every website the campaign holds, its own first, then by Experience Score, highest first, those without one last"},"instrument":{"type":"object","properties":{"changes":{"$ref":"#/components/schemas/ExperienceChanges"},"comparable":{"type":"boolean","description":"No change falls between the start of the window ending results.comparedTo and results.asOf, so every change compares like with like; false: the changes span an instrument change and no significance is claimed for them"}},"required":["changes","comparable"],"additionalProperties":false,"description":"The instrument changes among the as-of window's interactions the map pools; each marks every score on it"},"groupings":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","enum":["product","audience","channel"]},"sizedBy":{"type":"string","enum":["dollars","journeys"],"description":"The unit of the grouping's sizes: dollars (the size of experienceUsd, whichever way it points) for products (revenue lines) when one has Experience dollars, a line without any then weighing 0; otherwise judged journeys"},"segments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The profile's revenue, audience or channel mix id, as discovery_segment_win_rates_get_v2's revenue, audience and channel rows name the same segment; unassigned for journeys whose customer carries none"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name the campaign's frozen profile gives the segment; null where it names none by that id"},"judgedJourneys":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Journeys judged on the campaign's website in the segment, matched or not: the pass rate's denominator"},"experienceScore":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The website's Experience Score over the segment's judged journeys, 0 to 100; null where they leave none to claim"},"matchedPairs":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Matched pairs behind the gap: one per journey of ours and the same customer's on one competitor's website (same cycle and device), over the competitors with a score on both sides, so a customer who shopped three competitors is three pairs"},"ownScore":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The website's Experience Score over the matched pairs, 0 to 100, each competitor weighing as its pairs, so it can differ from the segment's own score; null without a gap"},"peerScore":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The competitors' Experience Score over the same pairs; null without a gap"},"gapPts":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"ownScore less peerScore, in points: the one gap every Experience read states for the segment; null with no matched pair or no score to compare (noGap says which)"},"noGap":{"anyOf":[{"type":"string","enum":["no_match","no_score"]},{"type":"null"}],"description":"Why gapPts is null: no_match when no journey of the segment is matched to a competitor's, no_score when it is matched and a side leaves no score; null when there is a gap"},"experienceUsd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"A product's (revenue line's) Experience dollars: one point of its gap, its AI-influenced market (SAM × AI influence in Tools › Products) ÷ 100, × gapPts; positive where the website serves AI shoppers better than the competitors' and negative where worse; null for an audience and for a line without market assumptions or a gap"},"size":{"type":"number","minimum":0,"description":"What the segment weighs on the map, in its grouping's sizedBy unit"}},"required":["id","label","judgedJourneys","experienceScore","matchedPairs","ownScore","peerScore","gapPts","noGap","experienceUsd","size"],"additionalProperties":false},"description":"Every segment the window judged a journey in, most judged first"}},"required":["key","sizedBy","segments"],"additionalProperties":false},"description":"Products (revenue lines), then audiences, then channels"}},"required":["datasetKey","competitorSourceCampaignId","matchedPairs","websites","instrument","groupings"],"additionalProperties":false},{"type":"null"}],"description":"Null while the scope holds no interaction, and for a campaign with no single website of its own"}},"required":["latestEntry","campaign","destinations","selectedDestination","dateScope","results","scopeEntries","scopeAgent","competition","metrics","map"],"additionalProperties":false},"ExperienceFrictionMapsGetV3Response":{"type":"object","properties":{"latestEntry":{"$ref":"#/components/schemas/ExperienceLatestEntry"},"campaign":{"$ref":"#/components/schemas/ExperienceCampaign"},"destinations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"url":{"anyOf":[{"type":"string"},{"type":"null"}]},"hostname":{"anyOf":[{"type":"string"},{"type":"null"}]},"isOriginalTarget":{"type":"boolean"}},"required":["id","name","url","hostname","isOriginalTarget"],"additionalProperties":false}},"selectedDestination":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"url":{"anyOf":[{"type":"string"},{"type":"null"}]},"hostname":{"anyOf":[{"type":"string"},{"type":"null"}]},"isOriginalTarget":{"type":"boolean"}},"required":["id","name","url","hostname","isOriginalTarget"],"additionalProperties":false},{"type":"null"}]},"dateScope":{"$ref":"#/components/schemas/ExperienceDateScope"},"results":{"$ref":"#/components/schemas/ExperienceResults"},"scopeEntries":{"type":"array","items":{"type":"object","properties":{"axis":{"type":"string","enum":["customer","store"]},"id":{"type":"string"},"label":{"type":"string","description":"The entry's name, as experience_campaign_segments_get names it"}},"required":["axis","id","label"],"additionalProperties":false},"description":"The read's customer and store segment entries the campaign holds, each with its label, in the order asked. An entry the campaign does not hold is not listed, and narrows the read to nothing. The agent entry is scopeAgent."},"scopeAgent":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","enum":["point11","dots","spark","muse","grok_bot"]},"label":{"type":"string","description":"The agent's brand, as experience_campaign_segments_get names it"}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"The agent entry the read applied: every figure is of that agent's visits alone. Null when the segment scope names no agent: the figures pool every agent's visits, and instrument names each agent's changes"},"competition":{"$ref":"#/components/schemas/ExperienceCompetition"},"metrics":{"type":"object","properties":{"plannedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"finishedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"queuedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"runningCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["plannedCount","finishedCount","queuedCount","runningCount"],"additionalProperties":false},"destinationIcons":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"object","properties":{"url":{"type":"string","description":"The stored favicon: a public object URL"},"tone":{"type":"string","enum":["dark","light","mixed","unknown"]},"transparent":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"needsLightBackplate":{"type":"boolean"},"needsDarkBackplate":{"type":"boolean"}},"required":["url","tone","transparent","needsLightBackplate","needsDarkBackplate"],"additionalProperties":false},"description":"Each website's stored favicon by destinations[].id; one without (no URL, or none stored) is absent and draws its name's initial"},"devices":{"type":"array","items":{"type":"string","enum":["desktop","mobile","ios_safari"]},"description":"The devices the campaign's visits run on from now, in product order: each one the map can be read for (device)"},"map":{"anyOf":[{"type":"object","properties":{"datasetKey":{"type":"string","description":"Names what the map was read from: the campaign, website, the day its results window is as of with the interactions it holds, the device and the segment scope. experience.friction-map-pages.get answers the same key while it describes the same map"},"device":{"anyOf":[{"type":"string","enum":["desktop","mobile","ios_safari"]},{"type":"null"}],"description":"The device the map's journeys visited on; null for every device"},"ready":{"type":"boolean","description":"False while the page visits of an interaction in the window are still being written: judgedJourneys and failedJourneys are whole, and pages and bands are empty because they are not known yet. It turns true within minutes"},"judgedJourneys":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Every journey the map holds: the pass rate's denominator for the same scope"},"failedJourneys":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Failed journeys among them, not counting a failure blamed on the shopper. Each ended on one page, so the pages' failedEnded sum to it"},"customers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The distinct customers the judged journeys are of"},"outcomes":{"type":"object","properties":{"clean":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Passed with no friction recorded"},"friction":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Passed, with at least one friction the scoring engine recorded, of any severity"},"failed":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Did not pass (a failure blamed on the shopper is no journey of the map)"}},"required":["clean","friction","failed"],"additionalProperties":false,"description":"How the journeys went: clean, friction, failed; they sum to the journeys counted"},"pages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":2048,"description":"A page's host and path with every segment that identifies one thing or one person read as :id (shop.example/products/:id), \":other\" for every page past the 12 most reached as one, or \":unknown\" for the journeys whose evidence names no page and the frictions seen where no page was recorded"},"kind":{"type":"string","enum":["page","other","unknown"]},"path":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The page's path, with its host in front where that is not the website's own; null for other and unknown"},"pages":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"How many pages other stands for; 1 for any other"},"journeys":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Judged journeys that reached the page"},"position":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The median, over those journeys, of how many pages into the journey the page first came (1 is where it began); null for unknown"},"ended":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Journeys that ended on the page"},"failedEnded":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Failed journeys that ended on the page"},"outcomes":{"type":"object","properties":{"clean":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Passed with no friction recorded"},"friction":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Passed, with at least one friction the scoring engine recorded, of any severity"},"failed":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Did not pass (a failure blamed on the shopper is no journey of the map)"}},"required":["clean","friction","failed"],"additionalProperties":false,"description":"How the journeys went: clean, friction, failed; they sum to the journeys counted"},"screens":{"maxItems":4,"type":"array","items":{"type":"object","properties":{"runId":{"type":"string","description":"The journey's run: its replay (experience_journeys_get) and, with artifactId, its screenshot (experience_run_artifacts_download)"},"artifactId":{"type":"string","description":"The screenshot's artifact id"},"step":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The step of the journey the screenshot was taken at, as it arrived on the page"},"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"The day the journey's visit is dated by"},"outcome":{"type":"string","enum":["clean","friction","failed"],"description":"How the journey went"}},"required":["runId","artifactId","step","day","outcome"],"additionalProperties":false},"description":"The page as the latest journeys that reached it first saw it, latest first, at most 4: each journey's screenshot from the step it arrived on the page. Empty for other and unknown, and short where a journey's screenshot is missing"}},"required":["id","kind","path","pages","journeys","position","ended","failedEnded","outcomes","screens"],"additionalProperties":false},"description":"The 12 pages the most journeys reached in the order journeys reach them, then other, then unknown. A page is a recorded URL by its mechanics alone: host and path, credentials, query, fragment and ;parameters dropped, and numeric, UUID, long hexadecimal, token-like and @-bearing segments read as :id."},"bands":{"type":"array","items":{"type":"object","properties":{"from":{"type":"string","minLength":1,"maxLength":2048,"description":"A page's host and path with every segment that identifies one thing or one person read as :id (shop.example/products/:id), \":other\" for every page past the 12 most reached as one, or \":unknown\" for the journeys whose evidence names no page and the frictions seen where no page was recorded"},"to":{"type":"string","minLength":1,"maxLength":2048,"description":"A page's host and path with every segment that identifies one thing or one person read as :id (shop.example/products/:id), \":other\" for every page past the 12 most reached as one, or \":unknown\" for the journeys whose evidence names no page and the frictions seen where no page was recorded"},"journeys":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct journeys that went from one page straight to the other, however many times each"},"outcomes":{"type":"object","properties":{"clean":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Passed with no friction recorded"},"friction":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Passed, with at least one friction the scoring engine recorded, of any severity"},"failed":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Did not pass (a failure blamed on the shopper is no journey of the map)"}},"required":["clean","friction","failed"],"additionalProperties":false,"description":"How the journeys went: clean, friction, failed; they sum to the journeys counted"}},"required":["from","to","journeys","outcomes"],"additionalProperties":false},"description":"Most journeys first"},"entries":{"type":"array","items":{"type":"object","properties":{"page":{"type":"string","minLength":1,"maxLength":2048,"description":"A page's host and path with every segment that identifies one thing or one person read as :id (shop.example/products/:id), \":other\" for every page past the 12 most reached as one, or \":unknown\" for the journeys whose evidence names no page and the frictions seen where no page was recorded"},"journeys":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Judged journeys whose first page this was"},"outcomes":{"type":"object","properties":{"clean":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Passed with no friction recorded"},"friction":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Passed, with at least one friction the scoring engine recorded, of any severity"},"failed":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Did not pass (a failure blamed on the shopper is no journey of the map)"}},"required":["clean","friction","failed"],"additionalProperties":false,"description":"How the journeys went: clean, friction, failed; they sum to the journeys counted"}},"required":["page","journeys","outcomes"],"additionalProperties":false},"description":"Where the journeys entered, most first: each page a journey first arrived on, and unknown for those that walked no known page. Empty while ready is false"},"coverage":{"type":"object","properties":{"couldNotTell":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Visits the scorer could not tell for a reason other than blocked (policy, infrastructure, cut short, does not apply); in no count"},"blocked":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Visits the scorer could not tell because a bot wall, CAPTCHA, access-denied page or login stopped them; in no count"}},"required":["couldNotTell","blocked"],"additionalProperties":false,"description":"The website's visits in the as-of window on the device, under the segment scope, that no count of the map holds; whole while ready is false"},"instrument":{"type":"object","properties":{"changes":{"$ref":"#/components/schemas/ExperienceChanges"},"comparable":{"type":"boolean","description":"No change falls between the start of the window ending results.comparedTo and results.asOf, so every change compares like with like; false: the changes span an instrument change and no significance is claimed for them"}},"required":["changes","comparable"],"additionalProperties":false,"description":"The instrument changes among the as-of window's interactions the map pools; each marks every count on it"}},"required":["datasetKey","device","ready","judgedJourneys","failedJourneys","customers","outcomes","pages","bands","entries","coverage","instrument"],"additionalProperties":false},{"type":"null"}],"description":"Null while the scope holds no interaction or no website to read"}},"required":["latestEntry","campaign","destinations","selectedDestination","dateScope","results","scopeEntries","scopeAgent","competition","metrics","destinationIcons","devices","map"],"additionalProperties":false},"ExperienceFrictionMapPagesGetV3Response":{"type":"object","properties":{"datasetKey":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The drawing these were read for, as experience_friction_maps_get_v3 names its map (map.datasetKey); another key than the map held means the view has changed. Null while the scope holds no interaction or no website to read"},"page":{"type":"string","minLength":1,"maxLength":2048,"description":"A page's host and path with every segment that identifies one thing or one person read as :id (shop.example/products/:id), \":other\" for every page past the 12 most reached as one, or \":unknown\" for the journeys whose evidence names no page and the frictions seen where no page was recorded"},"journeys":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Judged journeys with a friction on the page"},"frictions":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Every friction on the page; none while the map answers ready false, since no friction can be placed yet"},"listed":{"type":"array","items":{"type":"object","properties":{"issue":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The campaign's named issue the friction was grouped into; null until the issue grouping that runs when a cycle publishes has grouped it"},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The friction in the scoring engine's own words; null where the stored verdict kept none"},"severity":{"anyOf":[{"type":"string","enum":["blocker","major","minor"]},{"type":"null"}]},"step":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}],"description":"The step of the journey it was seen on; null where the stored verdict names none"},"replayRunId":{"type":"string","description":"The journey's replay, as experience_journeys_get_v1 takes it"}},"required":["issue","text","severity","step","replayRunId"],"additionalProperties":false},"description":"At most 50 from offset on; frictions counts them all. Named issues first, the one most journeys carry leading, then the frictions no issue holds yet; within each, the most severe first"}},"required":["datasetKey","page","journeys","frictions","listed"],"additionalProperties":false},"ExperienceCampaignOverviewGetV7Response":{"type":"object","properties":{"customerLocations":{"$ref":"#/components/schemas/ExperienceCustomerLocations"},"replayJourneys":{"$ref":"#/components/schemas/ExperienceReplayJourneys"},"results":{"$ref":"#/components/schemas/ExperienceResults"}},"required":["customerLocations","replayJourneys","results"],"additionalProperties":false},"ExperienceCampaignSegmentsGetResponse":{"type":"object","properties":{"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"}},"required":["id","label"],"additionalProperties":false}},"audiences":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"}},"required":["id","label"],"additionalProperties":false}},"channels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"}},"required":["id","label"],"additionalProperties":false}},"attributes":{"type":"array","items":{"type":"object","properties":{"axis":{"type":"string","enum":["market","age","householdIncome","education","lifeStage","areaType","companySize","buyerRole","seniority","occupation","job","triggerType","intentStage","language","gender"]},"members":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"}},"required":["id","label"],"additionalProperties":false}}},"required":["axis","members"],"additionalProperties":false},"description":"Every other customer attribute's buckets the campaign's customers carry (market, age, household income, ...), by axis, each labeled: an entry on that axis (axis:id) narrows a read to those customers"},"stores":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"}},"required":["id","label"],"additionalProperties":false}},"agents":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","enum":["point11","dots","spark","muse","grok_bot"]},"label":{"type":"string"}},"required":["id","label"],"additionalProperties":false},"description":"The agents the campaign's cycles shop with from now, in product order, by brand: an agent entry (axis agent) narrows a read to that agent's visits"}},"required":["campaignId","customers","audiences","channels","attributes","stores","agents"],"additionalProperties":false},"ExperienceCampaignCustomersListV2Response":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DiscoveryData3"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"totalCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"selectedCustomerIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"audienceTypes":{"type":"array","items":{"type":"string","enum":["b2b","b2c","prosumer","mixed"]},"description":"The audience types of the customers this list draws from, each read as a Buyer type (b2c is B2C; b2b, prosumer and mixed are B2B); a column only another Buyer type carries is not a column."}},"required":["data","nextCursor","totalCount","selectedCustomerIds","audienceTypes"],"additionalProperties":false},"ExperienceCampaignCustomersListV3Response":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DiscoveryData4"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"totalCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"selectedCustomerIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"audienceTypes":{"type":"array","items":{"type":"string","enum":["b2b","b2c","prosumer","mixed"]},"description":"The audience types of the customers this list draws from, each read as a Buyer type (b2c is B2C; b2b, prosumer and mixed are B2B); a column only another Buyer type carries is not a column."}},"required":["data","nextCursor","totalCount","selectedCustomerIds","audienceTypes"],"additionalProperties":false},"ExperienceStartEstimatesGetResponse":{"type":"object","properties":{"estimate":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"held"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"estimated"},"browserSlots":{"type":"integer","minimum":0,"maximum":9007199254740991},"visit":{"type":"object","properties":{"basis":{"type":"string","enum":["observed_median","visit_limit"]},"durationMs":{"type":"integer","minimum":0,"maximum":9007199254740991},"sampleCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["basis","durationMs","sampleCount"],"additionalProperties":false},"runCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"firstStartWithinMs":{"type":"integer","minimum":0,"maximum":9007199254740991},"allStartWithinMs":{"type":"integer","minimum":0,"maximum":9007199254740991},"observedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["kind","browserSlots","visit","runCount","firstStartWithinMs","allStartWithinMs","observedAt"],"additionalProperties":false}]}},"required":["estimate"],"additionalProperties":false},"ExperienceJourneysListResponse":{"type":"object","properties":{"data":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"runId":{"type":"string"},"inProgress":{"type":"boolean"},"executionStatus":{"anyOf":[{"type":"string","enum":["scheduled","waiting","running","completed","failed","cancelled"]},{"type":"null"}]},"visitIdentity":{"anyOf":[{"type":"object","properties":{"key":{"type":"string"},"scenarioId":{"anyOf":[{"type":"string"},{"type":"null"}]},"cycleId":{"anyOf":[{"type":"string"},{"type":"null"}]},"cycleCreatedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"repetition":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["key","scenarioId","cycleId","cycleCreatedAt","repetition"],"additionalProperties":false},{"type":"null"}]},"evidenceDisposition":{"anyOf":[{"type":"string","enum":["sufficient","insufficient","policy_limited","infrastructure_limited","scenario_mismatch"]},{"type":"null"}]},"customerId":{"type":"string"},"customerName":{"type":"string"},"customerJobTitle":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The customer's job title as the visit's scenario froze it; null when it named none"},"destinationName":{"type":"string"},"destinationFingerprint":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The website's id (experience_campaigns_get_v3's destinations[].id, which destinationFingerprint filters by); null for a visit no campaign website holds"},"browserDevice":{"type":"string","enum":["desktop","mobile"]},"agent":{"type":"string","enum":["point11","dots","spark","muse","grok_bot"],"description":"The agent that shopped the visit; point11 (Point11's own shopper) for a visit no campaign planned. Another agent's visit of the same customer, website and device is another row (visitIdentity.key ends in :<agent>)"},"nativeApp":{"anyOf":[{"type":"object","properties":{"platform":{"type":"string","enum":["ios","android"]},"buildId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$"},"appId":{"type":"string","minLength":1,"maxLength":255},"versionLabel":{"type":"string","minLength":1,"maxLength":120},"deviceName":{"type":"string","minLength":1,"maxLength":120},"osVersion":{"type":"string","minLength":1,"maxLength":80}},"required":["platform","buildId","sha256","appId","versionLabel","deviceName","osVersion"],"additionalProperties":false},{"type":"null"}]},"unavailableReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"achieved":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"qualityStars":{"anyOf":[{"type":"number"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"actionCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"durationMs":{"anyOf":[{"type":"number"},{"type":"null"}]},"frictionSteps":{"anyOf":[{"type":"array","items":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},{"type":"null"}]},"recording":{"type":"object","properties":{"thumbnailArtifactId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The journey's first stored screenshot, full size, downloaded with experience_run_artifacts_download_v1, v2 or v3; null when the visit stored none"},"durationMs":{"anyOf":[{"type":"number"},{"type":"null"}]},"stages":{"type":"array","items":{"type":"object","properties":{"stepNumber":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"tone":{"anyOf":[{"type":"string","enum":["progress","friction","failed"]},{"type":"null"}]},"label":{"type":"string"}},"required":["stepNumber","tone","label"],"additionalProperties":false}}},"required":["thumbnailArtifactId","durationMs","stages"],"additionalProperties":false}},"required":["runId","inProgress","executionStatus","visitIdentity","evidenceDisposition","customerId","customerName","customerJobTitle","destinationName","destinationFingerprint","browserDevice","agent","nativeApp","unavailableReason","achieved","qualityStars","completedAt","actionCount","durationMs","frictionSteps","recording"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"previousCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"totalCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"pageSize":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["data","nextCursor","previousCursor","totalCount","pageSize"],"additionalProperties":false},"ExperienceJourneysListV2Response":{"type":"object","properties":{"data":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"runId":{"type":"string"},"inProgress":{"type":"boolean"},"executionStatus":{"anyOf":[{"type":"string","enum":["scheduled","waiting","running","completed","failed","cancelled"]},{"type":"null"}]},"visitIdentity":{"anyOf":[{"type":"object","properties":{"key":{"type":"string"},"scenarioId":{"anyOf":[{"type":"string"},{"type":"null"}]},"cycleId":{"anyOf":[{"type":"string"},{"type":"null"}]},"cycleCreatedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"repetition":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["key","scenarioId","cycleId","cycleCreatedAt","repetition"],"additionalProperties":false},{"type":"null"}]},"evidenceDisposition":{"anyOf":[{"type":"string","enum":["sufficient","insufficient","policy_limited","infrastructure_limited","scenario_mismatch"]},{"type":"null"}]},"customerId":{"type":"string"},"customerName":{"type":"string"},"customerJobTitle":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The customer's job title as the visit's scenario froze it; null when it named none"},"destinationName":{"type":"string"},"destinationFingerprint":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The website's id (experience_campaigns_get_v3's destinations[].id, which destinationFingerprint filters by); null for a visit no campaign website holds"},"browserDevice":{"type":"string","enum":["desktop","mobile","ios_safari"]},"agent":{"type":"string","enum":["point11","dots","spark","muse","grok_bot"],"description":"The agent that shopped the visit; point11 (Point11's own shopper) for a visit no campaign planned. Another agent's visit of the same customer, website and device is another row (visitIdentity.key ends in :<agent>)"},"nativeApp":{"anyOf":[{"type":"object","properties":{"platform":{"type":"string","enum":["ios","android"]},"buildId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$"},"appId":{"type":"string","minLength":1,"maxLength":255},"versionLabel":{"type":"string","minLength":1,"maxLength":120},"deviceName":{"type":"string","minLength":1,"maxLength":120},"osVersion":{"type":"string","minLength":1,"maxLength":80}},"required":["platform","buildId","sha256","appId","versionLabel","deviceName","osVersion"],"additionalProperties":false},{"type":"null"}]},"unavailableReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"achieved":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"qualityStars":{"anyOf":[{"type":"number"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"actionCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"durationMs":{"anyOf":[{"type":"number"},{"type":"null"}]},"frictionSteps":{"anyOf":[{"type":"array","items":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},{"type":"null"}]},"recording":{"type":"object","properties":{"thumbnailArtifactId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The journey's first stored screenshot, full size, downloaded with experience_run_artifacts_download_v1, v2 or v3; null when the visit stored none"},"durationMs":{"anyOf":[{"type":"number"},{"type":"null"}]},"stages":{"type":"array","items":{"type":"object","properties":{"stepNumber":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"tone":{"anyOf":[{"type":"string","enum":["progress","friction","failed"]},{"type":"null"}]},"label":{"type":"string"}},"required":["stepNumber","tone","label"],"additionalProperties":false}}},"required":["thumbnailArtifactId","durationMs","stages"],"additionalProperties":false}},"required":["runId","inProgress","executionStatus","visitIdentity","evidenceDisposition","customerId","customerName","customerJobTitle","destinationName","destinationFingerprint","browserDevice","agent","nativeApp","unavailableReason","achieved","qualityStars","completedAt","actionCount","durationMs","frictionSteps","recording"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"previousCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"totalCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"pageSize":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["data","nextCursor","previousCursor","totalCount","pageSize"],"additionalProperties":false},"ExperienceJourneysListV3Response":{"type":"object","properties":{"data":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"runId":{"type":"string"},"inProgress":{"type":"boolean"},"executionStatus":{"anyOf":[{"type":"string","enum":["scheduled","waiting","running","completed","failed","cancelled"]},{"type":"null"}]},"visitIdentity":{"anyOf":[{"type":"object","properties":{"key":{"type":"string"},"scenarioId":{"anyOf":[{"type":"string"},{"type":"null"}]},"cycleId":{"anyOf":[{"type":"string"},{"type":"null"}]},"cycleCreatedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"repetition":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["key","scenarioId","cycleId","cycleCreatedAt","repetition"],"additionalProperties":false},{"type":"null"}]},"evidenceDisposition":{"anyOf":[{"type":"string","enum":["sufficient","insufficient","policy_limited","infrastructure_limited","scenario_mismatch"]},{"type":"null"}]},"customerId":{"type":"string"},"customerName":{"type":"string"},"customerJobTitle":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The customer's job title as the visit's scenario froze it; null when it named none"},"destinationName":{"type":"string"},"destinationFingerprint":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The website's id (experience_campaigns_get_v3's destinations[].id, which destinationFingerprint filters by); null for a visit no campaign website holds"},"browserDevice":{"type":"string","enum":["desktop","mobile","ios_safari"]},"agent":{"type":"string","enum":["point11","dots","spark","muse","grok_bot"],"description":"The agent that shopped the visit; point11 (Point11's own shopper) for a visit no campaign planned. Another agent's visit of the same customer, website and device is another row (visitIdentity.key ends in :<agent>)"},"nativeApp":{"anyOf":[{"type":"object","properties":{"platform":{"type":"string","enum":["ios","android"]},"buildId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$"},"appId":{"type":"string","minLength":1,"maxLength":255},"versionLabel":{"type":"string","minLength":1,"maxLength":120},"deviceName":{"type":"string","minLength":1,"maxLength":120},"osVersion":{"type":"string","minLength":1,"maxLength":80}},"required":["platform","buildId","sha256","appId","versionLabel","deviceName","osVersion"],"additionalProperties":false},{"type":"null"}]},"unavailableReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"achieved":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"qualityStars":{"anyOf":[{"type":"number"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"actionCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"durationMs":{"anyOf":[{"type":"number"},{"type":"null"}]},"frictionSteps":{"anyOf":[{"type":"array","items":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},{"type":"null"}]},"recording":{"type":"object","properties":{"thumbnailArtifactId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The journey's first stored screenshot, full size, downloaded with experience_run_artifacts_download_v1, v2 or v3; null when the visit stored none"},"durationMs":{"anyOf":[{"type":"number"},{"type":"null"}]},"stages":{"type":"array","items":{"type":"object","properties":{"stepNumber":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"tone":{"anyOf":[{"type":"string","enum":["progress","friction","uncertain","failed"]},{"type":"null"}]},"label":{"type":"string"}},"required":["stepNumber","tone","label"],"additionalProperties":false}}},"required":["thumbnailArtifactId","durationMs","stages"],"additionalProperties":false}},"required":["runId","inProgress","executionStatus","visitIdentity","evidenceDisposition","customerId","customerName","customerJobTitle","destinationName","destinationFingerprint","browserDevice","agent","nativeApp","unavailableReason","achieved","qualityStars","completedAt","actionCount","durationMs","frictionSteps","recording"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"previousCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"totalCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"pageSize":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["data","nextCursor","previousCursor","totalCount","pageSize"],"additionalProperties":false},"ExperienceJourneysListV4Response":{"type":"object","properties":{"data":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"runId":{"type":"string"},"inProgress":{"type":"boolean"},"executionStatus":{"anyOf":[{"type":"string","enum":["scheduled","waiting","running","completed","failed","cancelled"]},{"type":"null"}]},"visitIdentity":{"anyOf":[{"type":"object","properties":{"key":{"type":"string"},"scenarioId":{"anyOf":[{"type":"string"},{"type":"null"}]},"cycleId":{"anyOf":[{"type":"string"},{"type":"null"}]},"cycleCreatedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"repetition":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["key","scenarioId","cycleId","cycleCreatedAt","repetition"],"additionalProperties":false},{"type":"null"}]},"evidenceDisposition":{"anyOf":[{"type":"string","enum":["sufficient","insufficient","policy_limited","infrastructure_limited","scenario_mismatch"]},{"type":"null"}]},"customerId":{"type":"string"},"customerName":{"type":"string"},"customerJobTitle":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The customer's job title as the visit's scenario froze it; null when it named none"},"destinationName":{"type":"string"},"destinationFingerprint":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The website's id (experience_campaigns_get_v3's destinations[].id, which destinationFingerprint filters by); null for a visit no campaign website holds"},"browserDevice":{"type":"string","enum":["desktop","mobile","ios_safari"]},"agent":{"type":"string","enum":["point11","dots","spark","muse","grok_bot"],"description":"The agent that shopped the visit; point11 (Point11's own shopper) for a visit no campaign planned. Another agent's visit of the same customer, website and device is another row (visitIdentity.key ends in :<agent>)"},"nativeApp":{"anyOf":[{"type":"object","properties":{"platform":{"type":"string","enum":["ios","android"]},"buildId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$"},"appId":{"type":"string","minLength":1,"maxLength":255},"versionLabel":{"type":"string","minLength":1,"maxLength":120},"deviceName":{"type":"string","minLength":1,"maxLength":120},"osVersion":{"type":"string","minLength":1,"maxLength":80}},"required":["platform","buildId","sha256","appId","versionLabel","deviceName","osVersion"],"additionalProperties":false},{"type":"null"}]},"unavailableReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"achieved":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"qualityStars":{"anyOf":[{"type":"number"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"actionCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"durationMs":{"anyOf":[{"type":"number"},{"type":"null"}]},"frictionSteps":{"anyOf":[{"type":"array","items":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},{"type":"null"}]},"recording":{"type":"object","properties":{"thumbnailArtifactId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The journey's stored thumbnail: its first captured screen as a WebP sized for the overview's replay card (kind thumbnail), downloaded with experience_run_artifacts_download_v3; null until it is stored"},"durationMs":{"anyOf":[{"type":"number"},{"type":"null"}]},"stages":{"type":"array","items":{"type":"object","properties":{"stepNumber":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"tone":{"anyOf":[{"type":"string","enum":["progress","friction","uncertain","failed"]},{"type":"null"}]},"label":{"type":"string"}},"required":["stepNumber","tone","label"],"additionalProperties":false}}},"required":["thumbnailArtifactId","durationMs","stages"],"additionalProperties":false}},"required":["runId","inProgress","executionStatus","visitIdentity","evidenceDisposition","customerId","customerName","customerJobTitle","destinationName","destinationFingerprint","browserDevice","agent","nativeApp","unavailableReason","achieved","qualityStars","completedAt","actionCount","durationMs","frictionSteps","recording"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"previousCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"totalCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"pageSize":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["data","nextCursor","previousCursor","totalCount","pageSize"],"additionalProperties":false},"ExperienceJourneysListV5Response":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ExperienceData"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"previousCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"totalCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"pageSize":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["data","nextCursor","previousCursor","totalCount","pageSize"],"additionalProperties":false},"ExperienceJourneysGetResponse":{"type":"object","properties":{"runId":{"type":"string"},"startedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"isRunning":{"type":"boolean"},"replay":{"type":"array","items":{"type":"object","properties":{"customerId":{"anyOf":[{"type":"string"},{"type":"null"}]},"objectiveId":{"type":"string"},"objectiveType":{"type":"string"},"browserDevice":{"type":"string","enum":["desktop","mobile"]},"experimentalConditions":{"anyOf":[{"anyOf":[{"$ref":"#/components/schemas/ExperienceExperimentalConditions"},{"$ref":"#/components/schemas/ExperienceItemExperimentalConditions"},{"$ref":"#/components/schemas/ExperienceReplayItemExperimentalConditions"}]},{"type":"null"}]},"nativeApp":{"anyOf":[{"type":"object","properties":{"platform":{"type":"string","enum":["ios","android"]},"buildId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$"},"appId":{"type":"string","minLength":1,"maxLength":255},"versionLabel":{"type":"string","minLength":1,"maxLength":120},"deviceName":{"type":"string","minLength":1,"maxLength":120},"osVersion":{"type":"string","minLength":1,"maxLength":80}},"required":["platform","buildId","sha256","appId","versionLabel","deviceName","osVersion"],"additionalProperties":false},{"type":"null"}]},"customerBrief":{"anyOf":[{"type":"object","properties":{"jobTitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"employer":{"anyOf":[{"type":"string"},{"type":"null"}]},"locality":{"anyOf":[{"type":"string"},{"type":"null"}]},"trigger":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["jobTitle","employer","locality","trigger"],"additionalProperties":false},{"type":"null"}]},"title":{"type":"string"},"prompt":{"type":"string"},"customerMission":{"$ref":"#/components/schemas/ExperienceCustomerMission"},"successCriteria":{"readOnly":true,"type":"array","items":{"type":"string"}},"persona":{"anyOf":[{"type":"string"},{"type":"null"}]},"personaName":{"anyOf":[{"type":"string"},{"type":"null"}]},"avatarUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"success":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"evaluation":{"$ref":"#/components/schemas/ExperienceEvaluation"},"status":{"type":"string"},"completionStatus":{"anyOf":[{"type":"string"},{"type":"null"}]},"failureReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"durationMs":{"anyOf":[{"type":"number"},{"type":"null"}]},"tokens":{"type":"object","properties":{"input":{"anyOf":[{"type":"number"},{"type":"null"}]},"output":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["input","output"],"additionalProperties":false},"summary":{"anyOf":[{"type":"string"},{"type":"null"}]},"recommendation":{"anyOf":[{"type":"string"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"}},"initialScreenshotUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"narration":{"anyOf":[{"type":"object","properties":{"trackUrl":{"type":"string"},"durationMs":{"type":"number"}},"required":["trackUrl","durationMs"],"additionalProperties":false},{"type":"null"}]},"playbackDurationMs":{"type":"number"},"recordedActionCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"replayableActionFrameCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"unavailableReason":{"anyOf":[{"type":"string","enum":["evidence_retired"]},{"type":"null"}]},"frames":{"$ref":"#/components/schemas/ExperienceFrames"}},"required":["objectiveId","objectiveType","browserDevice","title","prompt","persona","personaName","avatarUrl","success","evaluation","status","completionStatus","failureReason","durationMs","tokens","summary","recommendation","tags","initialScreenshotUrl","narration","playbackDurationMs","recordedActionCount","replayableActionFrameCount","unavailableReason","frames"],"additionalProperties":false}},"unavailableReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"nativeApp":{"anyOf":[{"type":"object","properties":{"platform":{"type":"string","enum":["ios","android"]},"buildId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$"},"appId":{"type":"string","minLength":1,"maxLength":255},"versionLabel":{"type":"string","minLength":1,"maxLength":120},"deviceName":{"type":"string","minLength":1,"maxLength":120},"osVersion":{"type":"string","minLength":1,"maxLength":80}},"required":["platform","buildId","sha256","appId","versionLabel","deviceName","osVersion"],"additionalProperties":false},{"type":"null"}]},"agent":{"type":"string","enum":["point11","dots","spark","muse","grok_bot"],"description":"The agent that shopped the visit; point11 (Point11's own shopper) for a visit no campaign planned. Every other agent is simulated: the model its vendor's consumer agent runs, in Point11's browser"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Gateway model id the visit's Computer Use call ran (its newest attempt's, as the call recorded it); null before the call was recorded"},"navigation":{"anyOf":[{"type":"object","properties":{"campaignId":{"anyOf":[{"type":"string"},{"type":"null"}]},"current":{"anyOf":[{"$ref":"#/components/schemas/ExperienceCurrent"},{"type":"null"}]},"visits":{"type":"array","items":{"$ref":"#/components/schemas/ExperienceCurrent"}}},"required":["campaignId","current","visits"],"additionalProperties":false},{"type":"null"}]}},"required":["runId","startedAt","isRunning","replay","unavailableReason","nativeApp","agent","model","navigation"],"additionalProperties":false},"ExperienceJourneysGetV2Response":{"type":"object","properties":{"runId":{"type":"string"},"startedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"isRunning":{"type":"boolean"},"replay":{"type":"array","items":{"type":"object","properties":{"customerId":{"anyOf":[{"type":"string"},{"type":"null"}]},"objectiveId":{"type":"string"},"objectiveType":{"type":"string"},"browserDevice":{"type":"string","enum":["desktop","mobile","ios_safari"]},"experimentalConditions":{"$ref":"#/components/schemas/ExperienceReplayItemExperimentalConditions2"},"nativeApp":{"anyOf":[{"type":"object","properties":{"platform":{"type":"string","enum":["ios","android"]},"buildId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$"},"appId":{"type":"string","minLength":1,"maxLength":255},"versionLabel":{"type":"string","minLength":1,"maxLength":120},"deviceName":{"type":"string","minLength":1,"maxLength":120},"osVersion":{"type":"string","minLength":1,"maxLength":80}},"required":["platform","buildId","sha256","appId","versionLabel","deviceName","osVersion"],"additionalProperties":false},{"type":"null"}]},"customerBrief":{"anyOf":[{"type":"object","properties":{"jobTitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"employer":{"anyOf":[{"type":"string"},{"type":"null"}]},"locality":{"anyOf":[{"type":"string"},{"type":"null"}]},"trigger":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["jobTitle","employer","locality","trigger"],"additionalProperties":false},{"type":"null"}]},"title":{"type":"string"},"prompt":{"type":"string"},"customerMission":{"$ref":"#/components/schemas/ExperienceCustomerMission"},"successCriteria":{"readOnly":true,"type":"array","items":{"type":"string"}},"persona":{"anyOf":[{"type":"string"},{"type":"null"}]},"personaName":{"anyOf":[{"type":"string"},{"type":"null"}]},"avatarUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"success":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"evaluation":{"$ref":"#/components/schemas/ExperienceEvaluation"},"status":{"type":"string"},"completionStatus":{"anyOf":[{"type":"string"},{"type":"null"}]},"failureReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"durationMs":{"anyOf":[{"type":"number"},{"type":"null"}]},"tokens":{"type":"object","properties":{"input":{"anyOf":[{"type":"number"},{"type":"null"}]},"output":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["input","output"],"additionalProperties":false},"summary":{"anyOf":[{"type":"string"},{"type":"null"}]},"recommendation":{"anyOf":[{"type":"string"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"}},"initialScreenshotUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"narration":{"anyOf":[{"type":"object","properties":{"trackUrl":{"type":"string"},"durationMs":{"type":"number"}},"required":["trackUrl","durationMs"],"additionalProperties":false},{"type":"null"}]},"playbackDurationMs":{"type":"number"},"recordedActionCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"replayableActionFrameCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"unavailableReason":{"anyOf":[{"type":"string","enum":["evidence_retired"]},{"type":"null"}]},"frames":{"$ref":"#/components/schemas/ExperienceFrames"}},"required":["objectiveId","objectiveType","browserDevice","title","prompt","persona","personaName","avatarUrl","success","evaluation","status","completionStatus","failureReason","durationMs","tokens","summary","recommendation","tags","initialScreenshotUrl","narration","playbackDurationMs","recordedActionCount","replayableActionFrameCount","unavailableReason","frames"],"additionalProperties":false}},"unavailableReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"nativeApp":{"anyOf":[{"type":"object","properties":{"platform":{"type":"string","enum":["ios","android"]},"buildId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$"},"appId":{"type":"string","minLength":1,"maxLength":255},"versionLabel":{"type":"string","minLength":1,"maxLength":120},"deviceName":{"type":"string","minLength":1,"maxLength":120},"osVersion":{"type":"string","minLength":1,"maxLength":80}},"required":["platform","buildId","sha256","appId","versionLabel","deviceName","osVersion"],"additionalProperties":false},{"type":"null"}]},"agent":{"type":"string","enum":["point11","dots","spark","muse","grok_bot"],"description":"The agent that shopped the visit; point11 (Point11's own shopper) for a visit no campaign planned. Every other agent is simulated: the model its vendor's consumer agent runs, in Point11's browser"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Gateway model id the visit's Computer Use call ran (its newest attempt's, as the call recorded it); null before the call was recorded"},"navigation":{"$ref":"#/components/schemas/ExperienceNavigation"}},"required":["runId","startedAt","isRunning","replay","unavailableReason","nativeApp","agent","model","navigation"],"additionalProperties":false},"ExperienceJourneysGetV3Response":{"type":"object","properties":{"runId":{"type":"string"},"startedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"isRunning":{"type":"boolean"},"replay":{"type":"array","items":{"type":"object","properties":{"customerId":{"anyOf":[{"type":"string"},{"type":"null"}]},"objectiveId":{"type":"string"},"objectiveType":{"type":"string"},"browserDevice":{"type":"string","enum":["desktop","mobile","ios_safari"]},"experimentalConditions":{"$ref":"#/components/schemas/ExperienceReplayItemExperimentalConditions2"},"nativeApp":{"anyOf":[{"type":"object","properties":{"platform":{"type":"string","enum":["ios","android"]},"buildId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$"},"appId":{"type":"string","minLength":1,"maxLength":255},"versionLabel":{"type":"string","minLength":1,"maxLength":120},"deviceName":{"type":"string","minLength":1,"maxLength":120},"osVersion":{"type":"string","minLength":1,"maxLength":80}},"required":["platform","buildId","sha256","appId","versionLabel","deviceName","osVersion"],"additionalProperties":false},{"type":"null"}]},"customerBrief":{"anyOf":[{"type":"object","properties":{"jobTitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"employer":{"anyOf":[{"type":"string"},{"type":"null"}]},"locality":{"anyOf":[{"type":"string"},{"type":"null"}]},"trigger":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["jobTitle","employer","locality","trigger"],"additionalProperties":false},{"type":"null"}]},"title":{"type":"string"},"prompt":{"type":"string"},"customerMission":{"$ref":"#/components/schemas/ExperienceCustomerMission"},"successCriteria":{"readOnly":true,"type":"array","items":{"type":"string"}},"persona":{"anyOf":[{"type":"string"},{"type":"null"}]},"personaName":{"anyOf":[{"type":"string"},{"type":"null"}]},"avatarUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"success":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"evaluation":{"anyOf":[{"type":"object","properties":{"achieved":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"version":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"evidenceDisposition":{"type":"string","enum":["sufficient","insufficient","policy_limited","infrastructure_limited","scenario_mismatch"]},"moments":{"readOnly":true,"type":"array","items":{"type":"object","properties":{"stepNumber":{"type":"integer","minimum":0,"maximum":9007199254740991},"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"generation":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"assessment":{"type":"string","enum":["progress","reached","uncertain","friction","blocked","unassessed"]},"finding":{"type":"string","minLength":5,"maxLength":600}},"required":["stepNumber","artifactId","generation","assessment","finding"],"additionalProperties":false}},"qualityStars":{"anyOf":[{"type":"number"},{"type":"null"}]},"legacyProgressScore":{"anyOf":[{"type":"number"},{"type":"null"}]},"criteria":{"readOnly":true,"type":"array","items":{"readOnly":true,"type":"object","properties":{"criterion":{"type":"string"},"achieved":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"evidenceSteps":{"readOnly":true,"type":"array","items":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"finding":{"type":"string"}},"required":["criterion","achieved","evidenceSteps","finding"],"additionalProperties":false}},"frictions":{"readOnly":true,"maxItems":10,"type":"array","items":{"type":"object","properties":{"step":{"type":"integer","minimum":0,"maximum":9007199254740991},"what":{"type":"string","minLength":5,"maxLength":600},"severity":{"type":"string","enum":["blocker","major","minor"]}},"required":["step","what","severity"],"additionalProperties":false}},"blockedBy":{"type":"string","enum":["none","site","shopper","external","policy","infrastructure","unknown","scenario"]}},"required":["achieved","qualityStars","legacyProgressScore"],"additionalProperties":false},{"type":"null"}]},"status":{"type":"string"},"completionStatus":{"anyOf":[{"type":"string"},{"type":"null"}]},"failureReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"durationMs":{"anyOf":[{"type":"number"},{"type":"null"}]},"tokens":{"type":"object","properties":{"input":{"anyOf":[{"type":"number"},{"type":"null"}]},"output":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["input","output"],"additionalProperties":false},"summary":{"anyOf":[{"type":"string"},{"type":"null"}]},"recommendation":{"anyOf":[{"type":"string"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"}},"initialScreenshotUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"narration":{"anyOf":[{"type":"object","properties":{"trackUrl":{"type":"string"},"durationMs":{"type":"number"}},"required":["trackUrl","durationMs"],"additionalProperties":false},{"type":"null"}]},"playbackDurationMs":{"type":"number"},"recordedActionCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"replayableActionFrameCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"unavailableReason":{"anyOf":[{"type":"string","enum":["evidence_retired"]},{"type":"null"}]},"frames":{"$ref":"#/components/schemas/ExperienceFrames"}},"required":["objectiveId","objectiveType","browserDevice","title","prompt","persona","personaName","avatarUrl","success","evaluation","status","completionStatus","failureReason","durationMs","tokens","summary","recommendation","tags","initialScreenshotUrl","narration","playbackDurationMs","recordedActionCount","replayableActionFrameCount","unavailableReason","frames"],"additionalProperties":false}},"unavailableReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"nativeApp":{"anyOf":[{"type":"object","properties":{"platform":{"type":"string","enum":["ios","android"]},"buildId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$"},"appId":{"type":"string","minLength":1,"maxLength":255},"versionLabel":{"type":"string","minLength":1,"maxLength":120},"deviceName":{"type":"string","minLength":1,"maxLength":120},"osVersion":{"type":"string","minLength":1,"maxLength":80}},"required":["platform","buildId","sha256","appId","versionLabel","deviceName","osVersion"],"additionalProperties":false},{"type":"null"}]},"agent":{"type":"string","enum":["point11","dots","spark","muse","grok_bot"],"description":"The agent that shopped the visit; point11 (Point11's own shopper) for a visit no campaign planned. Every other agent is simulated: the model its vendor's consumer agent runs, in Point11's browser"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Gateway model id the visit's Computer Use call ran (its newest attempt's, as the call recorded it); null before the call was recorded"},"navigation":{"$ref":"#/components/schemas/ExperienceNavigation"}},"required":["runId","startedAt","isRunning","replay","unavailableReason","nativeApp","agent","model","navigation"],"additionalProperties":false},"ExperienceCustomerJourneysListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"runId":{"type":"string","description":"The journey's id; read its recording with experience_journeys_get"},"campaignId":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"type":"string"},"browserDevice":{"anyOf":[{"type":"string","enum":["desktop","mobile"]},{"type":"null"}]},"isNative":{"type":"boolean"},"executionStatus":{"anyOf":[{"type":"string","enum":["scheduled","waiting","running","completed","failed","cancelled"]},{"type":"null"}]},"startedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["runId","campaignId","label","browserDevice","isNative","executionStatus","startedAt"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"ExperienceCustomerJourneysListV2Response":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"runId":{"type":"string","description":"The journey's id; read its recording with experience_journeys_get_v3"},"campaignId":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"type":"string"},"browserDevice":{"anyOf":[{"type":"string","enum":["desktop","mobile","ios_safari"]},{"type":"null"}]},"isNative":{"type":"boolean"},"executionStatus":{"anyOf":[{"type":"string","enum":["scheduled","waiting","running","completed","failed","cancelled"]},{"type":"null"}]},"startedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["runId","campaignId","label","browserDevice","isNative","executionStatus","startedAt"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"ExperienceRunArtifactsDownloadResponse":{"type":"object","properties":{"filename":{"type":"string","minLength":1,"description":"Suggested file name for saving the bytes"},"contentType":{"type":"string","minLength":1},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Short-lived presigned URL that GETs the bytes; null when this deployment cannot sign the object"},"expiresAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}],"description":"When url stops working (minutes after the call); null with url"},"id":{"type":"string","description":"The artifact id"},"runId":{"type":"string"},"kind":{"type":"string","enum":["portrait","screenshot","narration"]}},"required":["filename","contentType","byteLength","url","expiresAt","id","runId","kind"],"additionalProperties":false},"ExperienceRunArtifactsDownloadV2Response":{"type":"object","properties":{"filename":{"type":"string","minLength":1,"description":"Suggested file name for saving the bytes"},"contentType":{"type":"string","minLength":1},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Short-lived presigned URL that GETs the bytes; null when this deployment cannot sign the object"},"expiresAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}],"description":"When url stops working (minutes after the call); null with url"},"id":{"type":"string","description":"The artifact id"},"runId":{"type":"string"},"kind":{"type":"string","enum":["portrait","screenshot","narration","thumbnail"]}},"required":["filename","contentType","byteLength","url","expiresAt","id","runId","kind"],"additionalProperties":false},"ExperienceRunArtifactsDownloadV3Response":{"type":"object","properties":{"filename":{"type":"string","minLength":1,"description":"Suggested file name for saving the bytes"},"contentType":{"type":"string","minLength":1},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Short-lived presigned URL that GETs the bytes; null when this deployment cannot sign the object"},"expiresAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}],"description":"When url stops working (minutes after the call); null with url"},"id":{"type":"string","description":"The artifact id"},"runId":{"type":"string"},"kind":{"type":"string","enum":["portrait","screenshot","narration","thumbnail","small_thumbnail"]}},"required":["filename","contentType","byteLength","url","expiresAt","id","runId","kind"],"additionalProperties":false},"ExperienceJourneysExportResponse":{"type":"object","properties":{"filename":{"type":"string","minLength":1,"description":"Suggested name for the assembled .zip"},"entries":{"$ref":"#/components/schemas/AlphaEntries"}},"required":["filename","entries"],"additionalProperties":false},"ExperienceConnectionsListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/ExperienceConnectionsRevokeResponse"}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"ExperienceConnectionsGetResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"environment":{"type":"string","enum":["test","production"]},"websiteUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"approvedOrigins":{"type":"array","items":{"type":"string"}},"deniedPaths":{"type":"array","items":{"type":"string"},"description":"Paths on the approved origins your journeys never request, each with everything below it, by any method: a request to one is refused and recorded on the step."},"actionPolicy":{"type":"string","enum":["observe","test_actions"]},"webAuthentication":{"$ref":"#/components/schemas/ExperienceWebAuthentication"},"nativeAuthentication":{"$ref":"#/components/schemas/ExperienceNativeAuthentication"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"status":{"type":"string","enum":["active","revoked"]},"domainVerification":{"$ref":"#/components/schemas/ExperienceDomainVerification"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"revokedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"accounts":{"type":"array","items":{"$ref":"#/components/schemas/ExperienceTestAccountsVerifyAppAccessResponse"}}},"required":["id","businessProfileId","name","environment","websiteUrl","approvedOrigins","deniedPaths","actionPolicy","webAuthentication","nativeAuthentication","revision","status","domainVerification","createdAt","updatedAt","revokedAt","accounts"],"additionalProperties":false},"ExperienceConnectionsCreateRequest":{"type":"object","properties":{"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":120},"environment":{"type":"string","enum":["test","production"]},"websiteUrl":{"anyOf":[{"type":"string","maxLength":2000,"format":"uri"},{"type":"null"}]},"approvedOrigins":{"maxItems":25,"type":"array","items":{"type":"string","maxLength":2000,"format":"uri"}},"deniedPaths":{"maxItems":25,"type":"array","items":{"type":"string","maxLength":500,"pattern":"^\\/[^\\s?#]+$"}},"actionPolicy":{"type":"string","enum":["observe","test_actions"]},"webAuthentication":{"$ref":"#/components/schemas/ExperienceWebAuthentication"},"nativeAuthentication":{"$ref":"#/components/schemas/ExperienceNativeAuthentication"}},"required":["businessProfileId","name","environment","websiteUrl","approvedOrigins","actionPolicy","webAuthentication"],"additionalProperties":false},"ExperienceConnectionsCreateResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"environment":{"type":"string","enum":["test","production"]},"websiteUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"approvedOrigins":{"type":"array","items":{"type":"string"}},"deniedPaths":{"type":"array","items":{"type":"string"},"description":"Paths on the approved origins your journeys never request, each with everything below it, by any method: a request to one is refused and recorded on the step."},"actionPolicy":{"type":"string","enum":["observe","test_actions"]},"webAuthentication":{"$ref":"#/components/schemas/ExperienceWebAuthentication"},"nativeAuthentication":{"$ref":"#/components/schemas/ExperienceNativeAuthentication"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"status":{"type":"string","enum":["active","revoked"]},"domainVerification":{"$ref":"#/components/schemas/ExperienceDomainVerification"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"revokedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]}},"required":["id","businessProfileId","name","environment","websiteUrl","approvedOrigins","deniedPaths","actionPolicy","webAuthentication","nativeAuthentication","revision","status","domainVerification","createdAt","updatedAt","revokedAt"],"additionalProperties":false},"ExperienceConnectionsUpdateRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"expectedRevision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"input":{"$ref":"#/components/schemas/ExperienceConnectionsCreateRequest"}},"required":["id","expectedRevision","input"],"additionalProperties":false},"ExperienceConnectionsUpdateResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"environment":{"type":"string","enum":["test","production"]},"websiteUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"approvedOrigins":{"type":"array","items":{"type":"string"}},"deniedPaths":{"type":"array","items":{"type":"string"},"description":"Paths on the approved origins your journeys never request, each with everything below it, by any method: a request to one is refused and recorded on the step."},"actionPolicy":{"type":"string","enum":["observe","test_actions"]},"webAuthentication":{"$ref":"#/components/schemas/ExperienceWebAuthentication"},"nativeAuthentication":{"$ref":"#/components/schemas/ExperienceNativeAuthentication"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"status":{"type":"string","enum":["active","revoked"]},"domainVerification":{"$ref":"#/components/schemas/ExperienceDomainVerification"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"revokedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]}},"required":["id","businessProfileId","name","environment","websiteUrl","approvedOrigins","deniedPaths","actionPolicy","webAuthentication","nativeAuthentication","revision","status","domainVerification","createdAt","updatedAt","revokedAt"],"additionalProperties":false},"ExperienceConnectionsRevokeRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"expectedRevision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["id","expectedRevision"],"additionalProperties":false},"ExperienceConnectionsRevokeResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"environment":{"type":"string","enum":["test","production"]},"websiteUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"approvedOrigins":{"type":"array","items":{"type":"string"}},"deniedPaths":{"type":"array","items":{"type":"string"},"description":"Paths on the approved origins your journeys never request, each with everything below it, by any method: a request to one is refused and recorded on the step."},"actionPolicy":{"type":"string","enum":["observe","test_actions"]},"webAuthentication":{"$ref":"#/components/schemas/ExperienceWebAuthentication"},"nativeAuthentication":{"$ref":"#/components/schemas/ExperienceNativeAuthentication"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"status":{"type":"string","enum":["active","revoked"]},"domainVerification":{"$ref":"#/components/schemas/ExperienceDomainVerification"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"revokedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]}},"required":["id","businessProfileId","name","environment","websiteUrl","approvedOrigins","deniedPaths","actionPolicy","webAuthentication","nativeAuthentication","revision","status","domainVerification","createdAt","updatedAt","revokedAt"],"additionalProperties":false},"ExperienceConnectionsVerifyDomainRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"expectedRevision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["id","expectedRevision"],"additionalProperties":false},"ExperienceConnectionsVerifyDomainResponse":{"type":"object","properties":{"connection":{"$ref":"#/components/schemas/ExperienceConnectionsRevokeResponse"},"verified":{"type":"boolean"},"proofs":{"type":"array","items":{"type":"object","properties":{"host":{"type":"string"},"method":{"type":"string","enum":["workos_domain","dns_txt","point11_preview"]},"domain":{"type":"string"}},"required":["host","method","domain"],"additionalProperties":false}},"unproven":{"type":"array","items":{"type":"string"},"description":"The hosts no proof covers yet; empty once verified."}},"required":["connection","verified","proofs","unproven"],"additionalProperties":false},"ExperienceTestAccountsListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"websiteUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"approvedOrigins":{"type":"array","items":{"type":"string"}},"domainVerified":{"type":"boolean","description":"Whether your organization has proved it controls the account's website (experience_connections_verify_domain_v1). An account signs in, and a campaign can cover it, only while it has."},"account":{"$ref":"#/components/schemas/ExperienceTestAccountsVerifyAppAccessResponse"}},"required":["websiteUrl","approvedOrigins","domainVerified","account"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"ExperienceTestAccountsCreateRequest":{"type":"object","properties":{"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"label":{"type":"string","minLength":1,"maxLength":120},"scenario":{"default":"","type":"string","maxLength":2000},"authenticationMethod":{"type":"string","enum":["password","browserbase_context"]}},"required":["connectionId","label","authenticationMethod"],"additionalProperties":false},"ExperienceTestAccountsCreateResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"label":{"type":"string"},"scenario":{"type":"string"},"authenticationMethod":{"type":"string","enum":["password","browserbase_context"]},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"status":{"type":"string","enum":["pending","active","revoked"]},"verifiedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"verifiedSurfaces":{"type":"array","items":{"type":"string","enum":["web","ios","android"]}},"lastCheckedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"lastFailureCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"ready":{"type":"boolean"},"revokedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]}},"required":["id","connectionId","label","scenario","authenticationMethod","revision","status","verifiedAt","verifiedSurfaces","lastCheckedAt","lastFailureCode","ready","revokedAt"],"additionalProperties":false},"ExperienceTestAccountsSavePasswordRequest":{"type":"object","properties":{"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"expectedRevision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"secret":{"type":"object","properties":{"username":{"type":"string","minLength":1,"maxLength":2000},"password":{"type":"string","minLength":1,"maxLength":10000},"totpSecret":{"type":"string","minLength":1,"maxLength":2000}},"required":["username","password"],"additionalProperties":false}},"required":["connectionId","accountId","expectedRevision"],"additionalProperties":false},"ExperienceTestAccountsSavePasswordResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"label":{"type":"string"},"scenario":{"type":"string"},"authenticationMethod":{"type":"string","enum":["password","browserbase_context"]},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"status":{"type":"string","enum":["pending","active","revoked"]},"verifiedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"verifiedSurfaces":{"type":"array","items":{"type":"string","enum":["web","ios","android"]}},"lastCheckedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"lastFailureCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"ready":{"type":"boolean"},"revokedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]}},"required":["id","connectionId","label","scenario","authenticationMethod","revision","status","verifiedAt","verifiedSurfaces","lastCheckedAt","lastFailureCode","ready","revokedAt"],"additionalProperties":false},"ExperienceTestAccountsRevokeRequest":{"type":"object","properties":{"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"expectedRevision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["connectionId","accountId","expectedRevision"],"additionalProperties":false},"ExperienceTestAccountsRevokeResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"label":{"type":"string"},"scenario":{"type":"string"},"authenticationMethod":{"type":"string","enum":["password","browserbase_context"]},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"status":{"type":"string","enum":["pending","active","revoked"]},"verifiedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"verifiedSurfaces":{"type":"array","items":{"type":"string","enum":["web","ios","android"]}},"lastCheckedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"lastFailureCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"ready":{"type":"boolean"},"revokedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]}},"required":["id","connectionId","label","scenario","authenticationMethod","revision","status","verifiedAt","verifiedSurfaces","lastCheckedAt","lastFailureCode","ready","revokedAt"],"additionalProperties":false},"ExperienceTestAccountsStartBrowserEnrollmentRequest":{"type":"object","properties":{"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"expectedRevision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"expectedConnectionRevision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["connectionId","accountId","expectedRevision","expectedConnectionRevision"],"additionalProperties":false},"ExperienceTestAccountsStartBrowserEnrollmentResponse":{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"liveViewUrl":{"type":"string","format":"uri"}},"required":["accountId","revision","liveViewUrl"],"additionalProperties":false},"ExperienceTestAccountsFinishBrowserEnrollmentRequest":{"type":"object","properties":{"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"expectedRevision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"expectedConnectionRevision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["connectionId","accountId","expectedRevision","expectedConnectionRevision"],"additionalProperties":false},"ExperienceTestAccountsFinishBrowserEnrollmentResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"label":{"type":"string"},"scenario":{"type":"string"},"authenticationMethod":{"type":"string","enum":["password","browserbase_context"]},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"status":{"type":"string","enum":["pending","active","revoked"]},"verifiedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"verifiedSurfaces":{"type":"array","items":{"type":"string","enum":["web","ios","android"]}},"lastCheckedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"lastFailureCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"ready":{"type":"boolean"},"revokedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]}},"required":["id","connectionId","label","scenario","authenticationMethod","revision","status","verifiedAt","verifiedSurfaces","lastCheckedAt","lastFailureCode","ready","revokedAt"],"additionalProperties":false},"ExperienceTestAccountsVerifyBrowserAccessRequest":{"type":"object","properties":{"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"expectedRevision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"expectedConnectionRevision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["connectionId","accountId","expectedRevision","expectedConnectionRevision"],"additionalProperties":false},"ExperienceTestAccountsVerifyBrowserAccessResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"label":{"type":"string"},"scenario":{"type":"string"},"authenticationMethod":{"type":"string","enum":["password","browserbase_context"]},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"status":{"type":"string","enum":["pending","active","revoked"]},"verifiedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"verifiedSurfaces":{"type":"array","items":{"type":"string","enum":["web","ios","android"]}},"lastCheckedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"lastFailureCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"ready":{"type":"boolean"},"revokedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]}},"required":["id","connectionId","label","scenario","authenticationMethod","revision","status","verifiedAt","verifiedSurfaces","lastCheckedAt","lastFailureCode","ready","revokedAt"],"additionalProperties":false},"ExperienceTestAccountsVerifyAppAccessRequest":{"type":"object","properties":{"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"expectedRevision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"expectedConnectionRevision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"buildId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"device":{"type":"object","properties":{"platform":{"type":"string","enum":["ios","android"]},"deviceName":{"type":"string","minLength":1,"maxLength":120},"osVersion":{"type":"string","minLength":1,"maxLength":80}},"required":["platform","deviceName","osVersion"],"additionalProperties":false}},"required":["connectionId","accountId","expectedRevision","expectedConnectionRevision","buildId","device"],"additionalProperties":false},"ExperienceTestAccountsVerifyAppAccessResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"label":{"type":"string"},"scenario":{"type":"string"},"authenticationMethod":{"type":"string","enum":["password","browserbase_context"]},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"status":{"type":"string","enum":["pending","active","revoked"]},"verifiedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"verifiedSurfaces":{"type":"array","items":{"type":"string","enum":["web","ios","android"]}},"lastCheckedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"lastFailureCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"ready":{"type":"boolean"},"revokedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]}},"required":["id","connectionId","label","scenario","authenticationMethod","revision","status","verifiedAt","verifiedSurfaces","lastCheckedAt","lastFailureCode","ready","revokedAt"],"additionalProperties":false},"ExperienceAppBuildsListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/ExperienceAppBuildsDeleteResponse"}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"ExperienceAppBuildsReserveUploadRequest":{"type":"object","properties":{"buildId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"platform":{"type":"string","enum":["ios","android"]},"appId":{"type":"string","minLength":1,"maxLength":255},"versionLabel":{"type":"string","minLength":1,"maxLength":120},"filename":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[^/\\\\\\u0000-\\u001f\\u007f]+$"},"contentType":{"type":"string","enum":["application/octet-stream","application/vnd.android.package-archive","application/zip"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":1000000000}},"required":["buildId","connectionId","platform","appId","versionLabel","filename","contentType","byteLength"],"additionalProperties":false},"ExperienceAppBuildsReserveUploadResponse":{"type":"object","properties":{"build":{"$ref":"#/components/schemas/ExperienceAppBuildsDeleteResponse"},"upload":{"type":"object","properties":{"method":{"type":"string","const":"PUT"},"url":{"type":"string","format":"uri"},"headers":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"expiresAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["method","url","headers","expiresAt"],"additionalProperties":false,"description":"Send the file as the body of exactly this request before expiresAt. The response body is JSON naming the stored file's etag; pass it to experience_app_builds_complete_upload."}},"required":["build","upload"],"additionalProperties":false},"ExperienceAppBuildsCompleteUploadRequest":{"type":"object","properties":{"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"buildId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"etag":{"type":"string","minLength":1,"maxLength":512}},"required":["connectionId","buildId","etag"],"additionalProperties":false},"ExperienceAppBuildsCompleteUploadResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"platform":{"type":"string","enum":["ios","android"]},"appId":{"type":"string"},"versionLabel":{"type":"string"},"filename":{"type":"string"},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"sha256":{"anyOf":[{"type":"string"},{"type":"null"}]},"uploadStatus":{"type":"string","enum":["pending","ready"]},"uploadExpiresAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$","description":"When the upload link closes. A pending version's file can arrive only before it, and it holds its version label until then; after it, recover the version or delete it."},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"deletionPending":{"type":"boolean","description":"Its deletion started but its file was not confirmed gone. It can no longer be uploaded or verified; delete it again to finish."}},"required":["id","connectionId","platform","appId","versionLabel","filename","byteLength","sha256","uploadStatus","uploadExpiresAt","createdAt","deletionPending"],"additionalProperties":false},"ExperienceAppBuildsRecoverUploadRequest":{"type":"object","properties":{"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"buildId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["connectionId","buildId"],"additionalProperties":false},"ExperienceAppBuildsRecoverUploadResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"platform":{"type":"string","enum":["ios","android"]},"appId":{"type":"string"},"versionLabel":{"type":"string"},"filename":{"type":"string"},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"sha256":{"anyOf":[{"type":"string"},{"type":"null"}]},"uploadStatus":{"type":"string","enum":["pending","ready"]},"uploadExpiresAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$","description":"When the upload link closes. A pending version's file can arrive only before it, and it holds its version label until then; after it, recover the version or delete it."},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"deletionPending":{"type":"boolean","description":"Its deletion started but its file was not confirmed gone. It can no longer be uploaded or verified; delete it again to finish."}},"required":["id","connectionId","platform","appId","versionLabel","filename","byteLength","sha256","uploadStatus","uploadExpiresAt","createdAt","deletionPending"],"additionalProperties":false},"ExperienceAppBuildsDeleteRequest":{"type":"object","properties":{"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"buildId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["connectionId","buildId"],"additionalProperties":false},"ExperienceAppBuildsDeleteResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"platform":{"type":"string","enum":["ios","android"]},"appId":{"type":"string"},"versionLabel":{"type":"string"},"filename":{"type":"string"},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"sha256":{"anyOf":[{"type":"string"},{"type":"null"}]},"uploadStatus":{"type":"string","enum":["pending","ready"]},"uploadExpiresAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$","description":"When the upload link closes. A pending version's file can arrive only before it, and it holds its version label until then; after it, recover the version or delete it."},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"deletionPending":{"type":"boolean","description":"Its deletion started but its file was not confirmed gone. It can no longer be uploaded or verified; delete it again to finish."}},"required":["id","connectionId","platform","appId","versionLabel","filename","byteLength","sha256","uploadStatus","uploadExpiresAt","createdAt","deletionPending"],"additionalProperties":false},"ExperienceNativeDevicesListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"platform":{"type":"string","enum":["ios","android"]},"deviceName":{"type":"string","minLength":1,"maxLength":120},"osVersion":{"type":"string","minLength":1,"maxLength":80}},"required":["platform","deviceName","osVersion"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"ExperienceDiagnosticSessionsStartRequest":{"type":"object","properties":{"url":{"type":"string","maxLength":2048,"format":"uri","description":"Where the test starts: an absolute http(s) URL on one of the organization's websites."},"task":{"type":"string","minLength":1,"maxLength":600,"description":"What a shopper tries to do, in plain words, as one task (for example: search for odor from the header and open the first result)."},"criteria":{"minItems":1,"maxItems":5,"type":"array","items":{"type":"string","minLength":1,"maxLength":300},"description":"What must be true for the task to count as working (for example: a detergent is among the first three results)."},"device":{"type":"string","enum":["desktop","mobile"]}},"required":["url","task","criteria","device"],"additionalProperties":false},"ExperienceDiagnosticSessionsStartResponse":{"type":"object","properties":{"testId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The started test; null when it was refused."},"refusal":{"anyOf":[{"type":"object","properties":{"state":{"type":"string","const":"refused"},"reason":{"type":"string","enum":["outside_site","unsafe","unavailable"]},"detail":{"type":"string","maxLength":600}},"required":["state","reason","detail"],"additionalProperties":false},{"type":"null"}],"description":"Why the test did not start; null when it did."}},"required":["testId","refusal"],"additionalProperties":false},"ExperienceDiagnosticSessionsGetResponse":{"type":"object","properties":{"result":{"oneOf":[{"type":"object","properties":{"state":{"type":"string","const":"running"},"testId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"startedAt":{"type":"string"}},"required":["state","testId","startedAt"],"additionalProperties":false},{"type":"object","properties":{"state":{"type":"string","const":"settled"},"testId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"startedAt":{"type":"string"},"settledAt":{"type":"string"},"device":{"type":"string","enum":["desktop","mobile"]},"verdict":{"type":"string","enum":["pass","fail","could_not_tell"]},"blame":{"anyOf":[{"type":"string","enum":["site","shopper","external"]},{"type":"null"}]},"reason":{"type":"string","maxLength":1200},"steps":{"maxItems":40,"type":"array","items":{"type":"string","maxLength":300}},"replayPath":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["state","testId","startedAt","settledAt","device","verdict","blame","reason","steps","replayPath"],"additionalProperties":false},{"type":"object","properties":{"state":{"type":"string","const":"failed"},"testId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"startedAt":{"type":"string"},"settledAt":{"type":"string"},"reason":{"type":"string","maxLength":600}},"required":["state","testId","startedAt","settledAt","reason"],"additionalProperties":false},{"type":"object","properties":{"state":{"type":"string","const":"refused"},"reason":{"type":"string","enum":["outside_site","unsafe","unavailable"]},"detail":{"type":"string","maxLength":600}},"required":["state","reason","detail"],"additionalProperties":false}]}},"required":["result"],"additionalProperties":false},"SitesSitesListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"organizationId":{"type":"string"},"template":{"type":"string","enum":["banking","government","retail","landing_page","marketing"]},"slug":{"type":"string"},"name":{"type":"string"},"config":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/JsonValue"}},{"type":"null"}]},"embedAllowedOrigins":{"type":"array","items":{"type":"string"}},"brandingId":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","enum":["active","draft","archived"]},"deletedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"customDomain":{"anyOf":[{"type":"string"},{"type":"null"}]},"agentChatId":{"anyOf":[{"type":"string"},{"type":"null"}]},"agentVoiceId":{"anyOf":[{"type":"string"},{"type":"null"}]},"chatAgentName":{"anyOf":[{"type":"string"},{"type":"null"}]},"voiceAgentName":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","organizationId","template","slug","name","config","embedAllowedOrigins","brandingId","status","deletedAt","createdAt","updatedAt","customDomain","agentChatId","agentVoiceId","chatAgentName","voiceAgentName"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"SitesSitesGetResponse":{"type":"object","properties":{"id":{"type":"string"},"organizationId":{"type":"string"},"template":{"type":"string","enum":["banking","government","retail","landing_page","marketing"]},"slug":{"type":"string"},"name":{"type":"string"},"config":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/JsonValue"}},{"type":"null"}]},"embedAllowedOrigins":{"type":"array","items":{"type":"string"}},"brandingId":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","enum":["active","draft","archived"]},"deletedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"customDomain":{"anyOf":[{"type":"string"},{"type":"null"}]},"agentChatId":{"anyOf":[{"type":"string"},{"type":"null"}]},"agentVoiceId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","organizationId","template","slug","name","config","embedAllowedOrigins","brandingId","status","deletedAt","createdAt","updatedAt","customDomain","agentChatId","agentVoiceId"],"additionalProperties":false},"SitesSitesCreateRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"slug":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[a-z0-9-]+$"},"template":{"type":"string","enum":["banking","government","retail","landing_page","marketing"]},"agentChatId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"agentVoiceId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customDomain":{"type":"string","maxLength":253},"config":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/JsonValue"}},"embedAllowedOrigins":{"maxItems":32,"type":"array","items":{"type":"string","minLength":8,"maxLength":276,"pattern":"^(https?):\\/\\/(localhost|[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?(?:\\.[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?)*)(?::([0-9]{1,5}))?$","description":"Exact normalized browser origin: http(s) scheme, lowercase host, and optional non-default port; no path, query, fragment, credentials, or wildcard."},"description":"Duplicate-free external origins allowed to embed this Site installation.","uniqueItems":true},"status":{"type":"string","enum":["active","draft","archived"]}},"required":["name","slug","template"],"additionalProperties":false},"SitesSitesCreateResponse":{"type":"object","properties":{"id":{"type":"string"},"organizationId":{"type":"string"},"template":{"type":"string","enum":["banking","government","retail","landing_page","marketing"]},"slug":{"type":"string"},"name":{"type":"string"},"config":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/JsonValue"}},{"type":"null"}]},"embedAllowedOrigins":{"type":"array","items":{"type":"string"}},"brandingId":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","enum":["active","draft","archived"]},"deletedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"customDomain":{"anyOf":[{"type":"string"},{"type":"null"}]},"agentChatId":{"anyOf":[{"type":"string"},{"type":"null"}]},"agentVoiceId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","organizationId","template","slug","name","config","embedAllowedOrigins","brandingId","status","deletedAt","createdAt","updatedAt","customDomain","agentChatId","agentVoiceId"],"additionalProperties":false},"SitesSitesUpdateRequest":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","minLength":1,"maxLength":200},"slug":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[a-z0-9-]+$"},"template":{"type":"string","enum":["banking","government","retail","landing_page","marketing"]},"status":{"type":"string","enum":["active","draft","archived"]},"agentChatId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"agentVoiceId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"customDomain":{"anyOf":[{"type":"string","maxLength":253},{"type":"null"}]},"config":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/JsonValue"}},{"type":"null"}]},"embedAllowedOrigins":{"maxItems":32,"type":"array","items":{"type":"string","minLength":8,"maxLength":276,"pattern":"^(https?):\\/\\/(localhost|[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?(?:\\.[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?)*)(?::([0-9]{1,5}))?$","description":"Exact normalized browser origin: http(s) scheme, lowercase host, and optional non-default port; no path, query, fragment, credentials, or wildcard."},"description":"Duplicate-free external origins allowed to embed this Site installation.","uniqueItems":true}},"required":["id"],"additionalProperties":false},"SitesSitesUpdateResponse":{"type":"object","properties":{"id":{"type":"string"},"organizationId":{"type":"string"},"template":{"type":"string","enum":["banking","government","retail","landing_page","marketing"]},"slug":{"type":"string"},"name":{"type":"string"},"config":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/JsonValue"}},{"type":"null"}]},"embedAllowedOrigins":{"type":"array","items":{"type":"string"}},"brandingId":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","enum":["active","draft","archived"]},"deletedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"customDomain":{"anyOf":[{"type":"string"},{"type":"null"}]},"agentChatId":{"anyOf":[{"type":"string"},{"type":"null"}]},"agentVoiceId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","organizationId","template","slug","name","config","embedAllowedOrigins","brandingId","status","deletedAt","createdAt","updatedAt","customDomain","agentChatId","agentVoiceId"],"additionalProperties":false},"SitesSitesDeleteRequest":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"additionalProperties":false},"SitesSitesDeleteResponse":{"type":"object","properties":{"deleted":{"type":"boolean","const":true},"siteId":{"type":"string"}},"required":["deleted","siteId"],"additionalProperties":false},"SitesDomainsListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/SitesDomainsDetachResponse"}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"SitesDomainsCreateRequest":{"type":"object","properties":{"domain":{"type":"string","minLength":1,"maxLength":253}},"required":["domain"],"additionalProperties":false},"SitesDomainsCreateResponse":{"type":"object","properties":{"id":{"type":"string"},"organizationId":{"type":"string"},"domain":{"type":"string"},"verified":{"type":"boolean"},"verificationToken":{"anyOf":[{"type":"string"},{"type":"null"}]},"verificationTokenExpiresAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"sslStatus":{"type":"string","enum":["pending","active","failed"]},"siteConfigurationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"pagePublicationId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The published Alpha page publication this domain serves, or null."},"pageArtifactId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The page version the domain serves, built for its own origin; attach again to move it to the page's live version."},"hostedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}],"description":"When Point11 confirmed the domain is on its hosting; until then the page's own link stays its indexed address."},"suspendedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}],"description":"When Point11 suspended the domain; a suspended domain serves nothing."},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["id","organizationId","domain","verified","verificationToken","verificationTokenExpiresAt","sslStatus","siteConfigurationId","pagePublicationId","pageArtifactId","hostedAt","suspendedAt","createdAt","updatedAt"],"additionalProperties":false},"SitesDomainsDeleteRequest":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"additionalProperties":false},"SitesDomainsDeleteResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true}},"required":["success"],"additionalProperties":false},"SitesDomainsVerifyRequest":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"additionalProperties":false},"SitesDomainsVerifyResponse":{"type":"object","properties":{"verified":{"type":"boolean"},"message":{"type":"string"}},"required":["verified","message"],"additionalProperties":false},"SitesDomainsAttachRequest":{"type":"object","properties":{"id":{"type":"string"},"pageId":{"type":"string","description":"Any version id of the published page; the domain serves its live version."}},"required":["id","pageId"],"additionalProperties":false},"SitesDomainsAttachResponse":{"type":"object","properties":{"id":{"type":"string"},"organizationId":{"type":"string"},"domain":{"type":"string"},"verified":{"type":"boolean"},"verificationToken":{"anyOf":[{"type":"string"},{"type":"null"}]},"verificationTokenExpiresAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"sslStatus":{"type":"string","enum":["pending","active","failed"]},"siteConfigurationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"pagePublicationId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The published Alpha page publication this domain serves, or null."},"pageArtifactId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The page version the domain serves, built for its own origin; attach again to move it to the page's live version."},"hostedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}],"description":"When Point11 confirmed the domain is on its hosting; until then the page's own link stays its indexed address."},"suspendedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}],"description":"When Point11 suspended the domain; a suspended domain serves nothing."},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["id","organizationId","domain","verified","verificationToken","verificationTokenExpiresAt","sslStatus","siteConfigurationId","pagePublicationId","pageArtifactId","hostedAt","suspendedAt","createdAt","updatedAt"],"additionalProperties":false},"SitesDomainsDetachRequest":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"additionalProperties":false},"SitesDomainsDetachResponse":{"type":"object","properties":{"id":{"type":"string"},"organizationId":{"type":"string"},"domain":{"type":"string"},"verified":{"type":"boolean"},"verificationToken":{"anyOf":[{"type":"string"},{"type":"null"}]},"verificationTokenExpiresAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"sslStatus":{"type":"string","enum":["pending","active","failed"]},"siteConfigurationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"pagePublicationId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The published Alpha page publication this domain serves, or null."},"pageArtifactId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The page version the domain serves, built for its own origin; attach again to move it to the page's live version."},"hostedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}],"description":"When Point11 confirmed the domain is on its hosting; until then the page's own link stays its indexed address."},"suspendedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}],"description":"When Point11 suspended the domain; a suspended domain serves nothing."},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["id","organizationId","domain","verified","verificationToken","verificationTokenExpiresAt","sslStatus","siteConfigurationId","pagePublicationId","pageArtifactId","hostedAt","suspendedAt","createdAt","updatedAt"],"additionalProperties":false},"AgentsAgentsListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/AgentsAgentsUpdateResponse"}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"AgentsAgentsListV2Response":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/AgentsAgentsUpdateV2Response"}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"AgentsAgentsGetResponse":{"type":"object","properties":{"id":{"type":"string"},"organizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"agentType":{"type":"string","enum":["chat","voice"]},"source":{"description":"Reads only: org for your agent, system for a Point11 default.","type":"string","enum":["org","system"]},"slug":{"type":"string"},"name":{"type":"string"},"greeting":{"anyOf":[{"type":"string"},{"type":"null"}]},"requireAuth":{"type":"boolean"},"status":{"type":"string","enum":["active","draft","archived"]},"deletedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"personality":{"description":"Chat agents only.","anyOf":[{"type":"string"},{"type":"null"}]},"systemPrompt":{"description":"Chat agents only.","anyOf":[{"type":"string"},{"type":"null"}]},"model":{"description":"Chat agents only.","anyOf":[{"type":"string"},{"type":"null"}]},"generateTitles":{"description":"Chat agents only.","type":"boolean"},"elevenlabsAgentId":{"description":"Voice agents only.","anyOf":[{"type":"string"},{"type":"null"}]},"voiceConfig":{"description":"Voice agents only.","anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/JsonValue"}},{"type":"null"}]},"provisioningOperationId":{"description":"Voice writes only: the background provider work this change started.","type":"string"},"maxToolSteps":{"description":"Chat agents only. Always null: nothing stores it.","anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["id","organizationId","agentType","slug","name","greeting","requireAuth","status","deletedAt","createdAt","updatedAt"],"additionalProperties":false},"AgentsAgentsGetV2Response":{"type":"object","properties":{"id":{"type":"string"},"organizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"agentType":{"type":"string","enum":["chat","voice"]},"source":{"description":"Reads only: org for your agent, system for a Point11 default.","type":"string","enum":["org","system"]},"slug":{"type":"string"},"name":{"type":"string"},"greeting":{"anyOf":[{"type":"string"},{"type":"null"}]},"requireAuth":{"type":"boolean"},"status":{"type":"string","enum":["active","draft","archived"]},"deletedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"personality":{"description":"Chat agents only.","anyOf":[{"type":"string"},{"type":"null"}]},"systemPrompt":{"description":"Chat agents only.","anyOf":[{"type":"string"},{"type":"null"}]},"model":{"description":"Chat agents only.","anyOf":[{"type":"string"},{"type":"null"}]},"generateTitles":{"description":"Chat agents only.","type":"boolean"},"elevenlabsAgentId":{"description":"Voice agents only.","anyOf":[{"type":"string"},{"type":"null"}]},"voiceConfig":{"description":"Voice agents only.","anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/JsonValue"}},{"type":"null"}]},"provisioningOperationId":{"description":"Voice writes only: the background provider work this change started.","type":"string"}},"required":["id","organizationId","agentType","slug","name","greeting","requireAuth","status","deletedAt","createdAt","updatedAt"],"additionalProperties":false},"AgentsAgentsCreateRequest":{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[a-z0-9-]+$"},"name":{"type":"string","minLength":1,"maxLength":200},"agentType":{"type":"string","enum":["chat","voice"]},"personality":{"description":"Chat agents only.","type":"string","maxLength":2000},"greeting":{"type":"string","minLength":1,"maxLength":2000},"systemPrompt":{"description":"Chat: up to 50,000 characters. Voice: non-empty after trimming; stored in its provider config.","type":"string","maxLength":50000},"model":{"description":"Chat agents only. A public agent (requireAuth false, as every new agent is) runs only openai/gpt-5.6-luna, anthropic/claude-haiku-4.5, anthropic/claude-sonnet-4.6, anthropic/claude-sonnet-5.","type":"string","enum":["openai/gpt-5.6-luna","anthropic/claude-haiku-4.5","anthropic/claude-sonnet-4.6","anthropic/claude-opus-5","openai/gpt-5.6-sol","anthropic/claude-sonnet-5","google/gemini-3.1-pro-preview","xai/grok-4.3"]},"status":{"description":"Voice agents are created as draft.","type":"string","enum":["active","draft","archived"]},"voiceConfig":{"description":"Voice agents only.","type":"object","properties":{"voiceId":{"type":"string","minLength":1,"maxLength":200},"language":{"type":"string","maxLength":10}},"additionalProperties":false}},"required":["slug","name","agentType"],"additionalProperties":false,"deprecated":true},"AgentsAgentsCreateResponse":{"type":"object","properties":{"id":{"type":"string"},"organizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"agentType":{"type":"string","enum":["chat","voice"]},"source":{"description":"Reads only: org for your agent, system for a Point11 default.","type":"string","enum":["org","system"]},"slug":{"type":"string"},"name":{"type":"string"},"greeting":{"anyOf":[{"type":"string"},{"type":"null"}]},"requireAuth":{"type":"boolean"},"status":{"type":"string","enum":["active","draft","archived"]},"deletedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"personality":{"description":"Chat agents only.","anyOf":[{"type":"string"},{"type":"null"}]},"systemPrompt":{"description":"Chat agents only.","anyOf":[{"type":"string"},{"type":"null"}]},"model":{"description":"Chat agents only.","anyOf":[{"type":"string"},{"type":"null"}]},"generateTitles":{"description":"Chat agents only.","type":"boolean"},"elevenlabsAgentId":{"description":"Voice agents only.","anyOf":[{"type":"string"},{"type":"null"}]},"voiceConfig":{"description":"Voice agents only.","anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/JsonValue"}},{"type":"null"}]},"provisioningOperationId":{"description":"Voice writes only: the background provider work this change started.","type":"string"},"maxToolSteps":{"description":"Chat agents only. Always null: nothing stores it.","anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["id","organizationId","agentType","slug","name","greeting","requireAuth","status","deletedAt","createdAt","updatedAt"],"additionalProperties":false},"AgentsAgentsCreateV2Request":{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[a-z0-9-]+$"},"name":{"type":"string","minLength":1,"maxLength":200},"agentType":{"type":"string","enum":["chat","voice"]},"personality":{"description":"Chat agents only.","type":"string","maxLength":2000},"greeting":{"type":"string","minLength":1,"maxLength":2000},"systemPrompt":{"description":"Chat: up to 50,000 characters. Voice: non-empty after trimming; stored in its provider config.","type":"string","maxLength":50000},"model":{"description":"Chat agents only. A public agent (requireAuth false, as every new agent is) runs only openai/gpt-5.6-luna, anthropic/claude-haiku-4.5, anthropic/claude-sonnet-4.6, anthropic/claude-sonnet-5.","type":"string","enum":["openai/gpt-5.6-luna","anthropic/claude-haiku-4.5","anthropic/claude-sonnet-4.6","anthropic/claude-opus-5","openai/gpt-5.6-sol","anthropic/claude-sonnet-5","google/gemini-3.1-pro-preview","xai/grok-4.3"]},"status":{"description":"Voice agents are created as draft.","type":"string","enum":["active","draft","archived"]},"voiceConfig":{"description":"Voice agents only.","type":"object","properties":{"voiceId":{"type":"string","minLength":1,"maxLength":200},"language":{"type":"string","maxLength":10}},"additionalProperties":false}},"required":["slug","name","agentType"],"additionalProperties":false},"AgentsAgentsCreateV2Response":{"type":"object","properties":{"id":{"type":"string"},"organizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"agentType":{"type":"string","enum":["chat","voice"]},"source":{"description":"Reads only: org for your agent, system for a Point11 default.","type":"string","enum":["org","system"]},"slug":{"type":"string"},"name":{"type":"string"},"greeting":{"anyOf":[{"type":"string"},{"type":"null"}]},"requireAuth":{"type":"boolean"},"status":{"type":"string","enum":["active","draft","archived"]},"deletedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"personality":{"description":"Chat agents only.","anyOf":[{"type":"string"},{"type":"null"}]},"systemPrompt":{"description":"Chat agents only.","anyOf":[{"type":"string"},{"type":"null"}]},"model":{"description":"Chat agents only.","anyOf":[{"type":"string"},{"type":"null"}]},"generateTitles":{"description":"Chat agents only.","type":"boolean"},"elevenlabsAgentId":{"description":"Voice agents only.","anyOf":[{"type":"string"},{"type":"null"}]},"voiceConfig":{"description":"Voice agents only.","anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/JsonValue"}},{"type":"null"}]},"provisioningOperationId":{"description":"Voice writes only: the background provider work this change started.","type":"string"}},"required":["id","organizationId","agentType","slug","name","greeting","requireAuth","status","deletedAt","createdAt","updatedAt"],"additionalProperties":false},"AgentsAgentsUpdateRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"agentType":{"type":"string","enum":["chat","voice"]},"slug":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[a-z0-9-]+$"},"name":{"type":"string","minLength":1,"maxLength":200},"greeting":{"anyOf":[{"type":"string","minLength":1,"maxLength":2000},{"type":"null"}]},"requireAuth":{"type":"boolean"},"personality":{"description":"Chat agents only.","anyOf":[{"type":"string","maxLength":2000},{"type":"null"}]},"systemPrompt":{"description":"Chat: up to 50,000 characters. Voice: non-empty after trimming. Null clears it.","anyOf":[{"type":"string","maxLength":50000},{"type":"null"}]},"model":{"description":"Chat agents only. A public agent (requireAuth false, as every new agent is) runs only openai/gpt-5.6-luna, anthropic/claude-haiku-4.5, anthropic/claude-sonnet-4.6, anthropic/claude-sonnet-5.","anyOf":[{"type":"string","enum":["openai/gpt-5.6-luna","anthropic/claude-haiku-4.5","anthropic/claude-sonnet-4.6","anthropic/claude-opus-5","openai/gpt-5.6-sol","anthropic/claude-sonnet-5","google/gemini-3.1-pro-preview","xai/grok-4.3"]},{"type":"null"}]},"status":{"description":"Chat agents only.","type":"string","enum":["active","draft","archived"]},"generateTitles":{"description":"Chat agents only.","type":"boolean"},"voiceConfig":{"description":"Voice agents only.","anyOf":[{"type":"object","properties":{"voiceId":{"type":"string","minLength":1,"maxLength":200},"language":{"type":"string","maxLength":10}},"additionalProperties":false},{"type":"null"}]},"maxToolSteps":{"description":"Chat agents only. Accepted and ignored: nothing stores it, and the turn deadline and Eve's session limits bound a turn.","anyOf":[{"type":"integer","minimum":1,"maximum":6},{"type":"null"}]}},"required":["id","agentType"],"additionalProperties":false,"deprecated":true},"AgentsAgentsUpdateResponse":{"type":"object","properties":{"id":{"type":"string"},"organizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"agentType":{"type":"string","enum":["chat","voice"]},"source":{"description":"Reads only: org for your agent, system for a Point11 default.","type":"string","enum":["org","system"]},"slug":{"type":"string"},"name":{"type":"string"},"greeting":{"anyOf":[{"type":"string"},{"type":"null"}]},"requireAuth":{"type":"boolean"},"status":{"type":"string","enum":["active","draft","archived"]},"deletedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"personality":{"description":"Chat agents only.","anyOf":[{"type":"string"},{"type":"null"}]},"systemPrompt":{"description":"Chat agents only.","anyOf":[{"type":"string"},{"type":"null"}]},"model":{"description":"Chat agents only.","anyOf":[{"type":"string"},{"type":"null"}]},"generateTitles":{"description":"Chat agents only.","type":"boolean"},"elevenlabsAgentId":{"description":"Voice agents only.","anyOf":[{"type":"string"},{"type":"null"}]},"voiceConfig":{"description":"Voice agents only.","anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/JsonValue"}},{"type":"null"}]},"provisioningOperationId":{"description":"Voice writes only: the background provider work this change started.","type":"string"},"maxToolSteps":{"description":"Chat agents only. Always null: nothing stores it.","anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["id","organizationId","agentType","slug","name","greeting","requireAuth","status","deletedAt","createdAt","updatedAt"],"additionalProperties":false},"AgentsAgentsUpdateV2Request":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"agentType":{"type":"string","enum":["chat","voice"]},"slug":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[a-z0-9-]+$"},"name":{"type":"string","minLength":1,"maxLength":200},"greeting":{"anyOf":[{"type":"string","minLength":1,"maxLength":2000},{"type":"null"}]},"requireAuth":{"type":"boolean"},"personality":{"description":"Chat agents only.","anyOf":[{"type":"string","maxLength":2000},{"type":"null"}]},"systemPrompt":{"description":"Chat: up to 50,000 characters. Voice: non-empty after trimming. Null clears it.","anyOf":[{"type":"string","maxLength":50000},{"type":"null"}]},"model":{"description":"Chat agents only. A public agent (requireAuth false, as every new agent is) runs only openai/gpt-5.6-luna, anthropic/claude-haiku-4.5, anthropic/claude-sonnet-4.6, anthropic/claude-sonnet-5.","anyOf":[{"type":"string","enum":["openai/gpt-5.6-luna","anthropic/claude-haiku-4.5","anthropic/claude-sonnet-4.6","anthropic/claude-opus-5","openai/gpt-5.6-sol","anthropic/claude-sonnet-5","google/gemini-3.1-pro-preview","xai/grok-4.3"]},{"type":"null"}]},"status":{"description":"Chat agents only.","type":"string","enum":["active","draft","archived"]},"generateTitles":{"description":"Chat agents only.","type":"boolean"},"voiceConfig":{"description":"Voice agents only.","anyOf":[{"type":"object","properties":{"voiceId":{"type":"string","minLength":1,"maxLength":200},"language":{"type":"string","maxLength":10}},"additionalProperties":false},{"type":"null"}]}},"required":["id","agentType"],"additionalProperties":false},"AgentsAgentsUpdateV2Response":{"type":"object","properties":{"id":{"type":"string"},"organizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"agentType":{"type":"string","enum":["chat","voice"]},"source":{"description":"Reads only: org for your agent, system for a Point11 default.","type":"string","enum":["org","system"]},"slug":{"type":"string"},"name":{"type":"string"},"greeting":{"anyOf":[{"type":"string"},{"type":"null"}]},"requireAuth":{"type":"boolean"},"status":{"type":"string","enum":["active","draft","archived"]},"deletedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"personality":{"description":"Chat agents only.","anyOf":[{"type":"string"},{"type":"null"}]},"systemPrompt":{"description":"Chat agents only.","anyOf":[{"type":"string"},{"type":"null"}]},"model":{"description":"Chat agents only.","anyOf":[{"type":"string"},{"type":"null"}]},"generateTitles":{"description":"Chat agents only.","type":"boolean"},"elevenlabsAgentId":{"description":"Voice agents only.","anyOf":[{"type":"string"},{"type":"null"}]},"voiceConfig":{"description":"Voice agents only.","anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/JsonValue"}},{"type":"null"}]},"provisioningOperationId":{"description":"Voice writes only: the background provider work this change started.","type":"string"}},"required":["id","organizationId","agentType","slug","name","greeting","requireAuth","status","deletedAt","createdAt","updatedAt"],"additionalProperties":false},"AgentsAgentsDeleteRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"agentType":{"type":"string","enum":["chat","voice"]}},"required":["id","agentType"],"additionalProperties":false},"AgentsAgentsDeleteResponse":{"type":"object","properties":{"deleted":{"type":"boolean","const":true},"archived":{"type":"boolean"},"agentId":{"type":"string"},"provisioningOperationId":{"type":"string"}},"required":["deleted","archived","agentId"],"additionalProperties":false},"AgentsAgentAnalyticsGetResponse":{"type":"object","properties":{"agentType":{"type":"string","enum":["chat","voice"]},"range":{"type":"string","enum":["7d","30d","90d"]},"rangeStart":{"type":"string"},"rangeEnd":{"type":"string"},"agentId":{"type":"string"},"agentSlug":{"type":"string"},"agentName":{"type":"string"},"chat":{"description":"Present when agentType is chat.","type":"object","properties":{"volume":{"type":"object","properties":{"totalConversations":{"type":"number"},"totalMessages":{"type":"number"},"daily":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"conversations":{"type":"number"},"messages":{"type":"number"}},"required":["date","conversations","messages"],"additionalProperties":false}}},"required":["totalConversations","totalMessages","daily"],"additionalProperties":false},"engagement":{"type":"object","properties":{"avgMessagesPerConversation":{"type":"number"},"avgConversationDurationSeconds":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["avgMessagesPerConversation","avgConversationDurationSeconds"],"additionalProperties":false},"topTools":{"type":"array","items":{"type":"object","properties":{"toolName":{"type":"string"},"callCount":{"type":"number"},"conversationShare":{"type":"number"}},"required":["toolName","callCount","conversationShare"],"additionalProperties":false}},"abandonment":{"type":"object","properties":{"abandonedCount":{"type":"number"},"abandonmentRate":{"type":"number"}},"required":["abandonedCount","abandonmentRate"],"additionalProperties":false},"latency":{"type":"object","properties":{"p50Ms":{"anyOf":[{"type":"number"},{"type":"null"}]},"p95Ms":{"anyOf":[{"type":"number"},{"type":"null"}]},"approximationNote":{"type":"string"}},"required":["p50Ms","p95Ms","approximationNote"],"additionalProperties":false}},"required":["volume","engagement","topTools","abandonment","latency"],"additionalProperties":false},"voice":{"description":"Present when agentType is voice.","type":"object","properties":{"volume":{"type":"object","properties":{"totalSessions":{"type":"number"},"completedSessions":{"type":"number"},"daily":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"sessions":{"type":"number"},"completed":{"type":"number"},"successful":{"type":"number"},"failed":{"type":"number"},"unknown":{"type":"number"},"durationSeconds":{"type":"number"}},"required":["date","sessions","completed","successful","failed","unknown","durationSeconds"],"additionalProperties":false}}},"required":["totalSessions","completedSessions","daily"],"additionalProperties":false},"engagement":{"type":"object","properties":{"avgSessionDurationSeconds":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["avgSessionDurationSeconds"],"additionalProperties":false},"outcome":{"type":"object","properties":{"successfulCount":{"type":"number"},"failedCount":{"type":"number"},"unknownCount":{"type":"number"},"incompleteCount":{"type":"number"},"successRate":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["successfulCount","failedCount","unknownCount","incompleteCount","successRate"],"additionalProperties":false}},"required":["volume","engagement","outcome"],"additionalProperties":false}},"required":["agentType","range","rangeStart","rangeEnd","agentId","agentSlug","agentName"],"additionalProperties":false},"AgentsConversationsGetResponse":{"type":"object","properties":{"conversation":{"type":"object","properties":{"id":{"type":"string"},"channel":{"anyOf":[{"type":"string"},{"type":"null"}]},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"}},"required":["id","channel","title","createdAt"],"additionalProperties":false},"messages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string"},"content":{"anyOf":[{"type":"string"},{"type":"null"}]},"toolInvocations":{"$ref":"#/components/schemas/JsonValue"},"model":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"}},"required":["id","role","content","toolInvocations","model","createdAt"],"additionalProperties":false}}},"required":["conversation","messages"],"additionalProperties":false},"AgentsConversationsExportResponse":{"type":"object","properties":{"exportId":{"type":"string"},"format":{"type":"string","enum":["json","csv"]},"filename":{"type":"string"},"contentType":{"type":"string"},"content":{"type":"string"},"conversationCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"byteSize":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["exportId","format","filename","contentType","content","conversationCount","byteSize"],"additionalProperties":false},"CollaborationCommentThreadsSyncResponse":{"type":"object","properties":{"threads":{"maxItems":50,"type":"array","items":{"$ref":"#/components/schemas/CollaborationThreadsItem"}},"deletedThreadIds":{"maxItems":50,"type":"array","items":{"type":"string"},"description":"Threads deleted since `since`; empty for a page"},"cursor":{"type":"string","description":"Pass as `since` to read later changes"},"nextPageCursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Pass as `pageCursor` for older threads; null when none remain"},"hasMoreChanges":{"type":"boolean","description":"More changes are waiting: call again with `cursor` as `since`"}},"required":["threads","deletedThreadIds","cursor","nextPageCursor","hasMoreChanges"],"additionalProperties":false},"CollaborationCommentThreadsGetResponse":{"type":"object","properties":{"thread":{"$ref":"#/components/schemas/CollaborationThreadsItem"}},"required":["thread"],"additionalProperties":false},"CollaborationCommentThreadsCountUnreadResponse":{"type":"object","properties":{"unreadCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"mentionCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Unread threads with a comment that mentions the caller"},"hasThreads":{"type":"boolean","description":"Whether the organization has any comment threads"}},"required":["unreadCount","mentionCount","hasThreads"],"additionalProperties":false},"CollaborationCommentThreadsListMentionsResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"commentId":{"type":"string"},"body":{"type":"string","description":"The comment's text"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"author":{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"type":"string"},"imageUrl":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","email","imageUrl"],"additionalProperties":false},"thread":{"type":"object","properties":{"id":{"type":"string"},"surfaceId":{"type":"string"},"artifactId":{"type":"string"},"canonicalHref":{"type":"string","description":"The dashboard path the thread was left on"},"anchor":{"$ref":"#/components/schemas/CollaborationAnchor"},"status":{"type":"string","enum":["open","resolved"]},"unread":{"type":"boolean","description":"Whether the thread changed since the caller last read it"}},"required":["id","surfaceId","artifactId","canonicalHref","anchor","status","unread"],"additionalProperties":false},"campaignName":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The campaign the thread is about; null when it has no name or no longer exists"}},"required":["commentId","body","createdAt","author","thread","campaignName"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"CollaborationCommentThreadsCreateRequest":{"type":"object","properties":{"surfaceId":{"type":"string","minLength":1,"maxLength":100,"description":"The commentable page, e.g. campaigns.discovery.overview"},"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The campaign or run the page shows"},"anchor":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"metric_card"},"key":{"type":"string","minLength":1,"maxLength":200},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["kind","key","label"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"table_card"},"key":{"type":"string","minLength":1,"maxLength":200},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["kind","key","label"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"report_section"},"key":{"type":"string","minLength":1,"maxLength":200},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["kind","key","label"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"replay"},"key":{"type":"string","const":"replay"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["kind","key","label"],"additionalProperties":false}],"description":"The card, section, or replay the thread is about"},"viewState":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/JsonValue"},"description":"The page state to return to, as the surface defines it"},"body":{"type":"string","minLength":1,"maxLength":16384,"description":"The comment text; at most 4000 characters once trimmed"},"mentionedUserIds":{"default":[],"description":"Ids of organization members to mention (from collaboration.mentionable-members.list)","maxItems":20,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},"required":["surfaceId","artifactId","anchor","viewState","body"],"additionalProperties":false},"CollaborationCommentThreadsCreateResponse":{"type":"object","properties":{"thread":{"$ref":"#/components/schemas/CollaborationThreadsItem"},"commentId":{"type":"string","description":"The id of the comment this call posted"}},"required":["thread","commentId"],"additionalProperties":false},"CollaborationCommentThreadsReplyRequest":{"type":"object","properties":{"threadId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The comment thread's id"},"parentCommentId":{"description":"Reply inline under this comment of the thread","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"body":{"type":"string","minLength":1,"maxLength":16384,"description":"The comment text; at most 4000 characters once trimmed"},"mentionedUserIds":{"default":[],"description":"Ids of organization members to mention (from collaboration.mentionable-members.list)","maxItems":20,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},"required":["threadId","body"],"additionalProperties":false},"CollaborationCommentThreadsReplyResponse":{"type":"object","properties":{"thread":{"$ref":"#/components/schemas/CollaborationThreadsItem"},"commentId":{"type":"string","description":"The id of the comment this call posted"}},"required":["thread","commentId"],"additionalProperties":false},"CollaborationCommentThreadsSetStatusRequest":{"type":"object","properties":{"threadId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The comment thread's id"},"status":{"type":"string","enum":["open","resolved"],"description":"`resolved` closes the thread; `open` reopens it"}},"required":["threadId","status"],"additionalProperties":false},"CollaborationCommentThreadsSetStatusResponse":{"type":"object","properties":{"thread":{"$ref":"#/components/schemas/CollaborationThreadsItem"}},"required":["thread"],"additionalProperties":false},"CollaborationCommentThreadsMarkReadRequest":{"type":"object","properties":{"threadId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The comment thread's id"}},"required":["threadId"],"additionalProperties":false},"CollaborationCommentThreadsMarkReadResponse":{"type":"object","properties":{"threadId":{"type":"string"}},"required":["threadId"],"additionalProperties":false},"CollaborationCommentInvitationsCreateRequest":{"type":"object","properties":{"threadId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The thread of the comment"},"commentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"A comment the caller wrote"},"invitations":{"minItems":1,"maxItems":5,"type":"array","items":{"type":"object","properties":{"email":{"type":"string","maxLength":320,"format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"operationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"One per address; reuse it on retry to replay the same invitation"}},"required":["email","operationId"],"additionalProperties":false}}},"required":["threadId","commentId","invitations"],"additionalProperties":false},"CollaborationCommentInvitationsCreateResponse":{"type":"object","properties":{"thread":{"$ref":"#/components/schemas/CollaborationThreadsItem"},"invitations":{"maxItems":5,"type":"array","items":{"oneOf":[{"type":"object","properties":{"email":{"type":"string"},"status":{"type":"string","const":"invited"},"invitationId":{"type":"string"}},"required":["email","status","invitationId"],"additionalProperties":false},{"type":"object","properties":{"email":{"type":"string"},"status":{"type":"string","const":"mentioned","description":"The address is a member's, so they were mentioned"},"user":{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"type":"string"},"imageUrl":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","email","imageUrl"],"additionalProperties":false}},"required":["email","status","user"],"additionalProperties":false},{"type":"object","properties":{"email":{"type":"string"},"status":{"type":"string","const":"failed"},"error":{"type":"string","description":"Why Identity did not issue this invitation"}},"required":["email","status","error"],"additionalProperties":false}]}}},"required":["thread","invitations"],"additionalProperties":false},"CollaborationMentionableMembersListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"type":"string"},"imageUrl":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","email","imageUrl"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"viewer":{"anyOf":[{"type":"object","properties":{"user":{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"type":"string"},"imageUrl":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","email","imageUrl"],"additionalProperties":false},"canInvite":{"type":"boolean","description":"Whether the caller's comments may invite outside addresses (collaboration.comment-invitations.create)"}},"required":["user","canInvite"],"additionalProperties":false},{"type":"null"}],"description":"The signed-in caller as a comment author; null for an API key"}},"required":["data","nextCursor","viewer"],"additionalProperties":false},"CollaborationPresenceTouchRequest":{"type":"object","properties":{"tabId":{"description":"The browser tab touching presence, so its leave can end it; after that leave this id renews nothing, so touch under a new one. A touch without one ends only by expiry","type":"string","pattern":"^[A-Za-z0-9_-]{1,64}$"}},"additionalProperties":false},"CollaborationPresenceTouchResponse":{"type":"object","properties":{"viewers":{"maxItems":3,"type":"array","items":{"type":"object","properties":{"userId":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"initials":{"type":"string"},"imageUrl":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["userId","name","initials","imageUrl"],"additionalProperties":false},"description":"Other members active now, the most recent arrival first, at most a handful"},"total":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"How many other members are active now"},"nextHeartbeatMs":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"Touch again after this many milliseconds to stay present"}},"required":["viewers","total","nextHeartbeatMs"],"additionalProperties":false},"CollaborationPresenceLeaveRequest":{"type":"object","properties":{"tabId":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,64}$","description":"The browser tab leaving, as its touches named it; after this leave the id renews nothing, so touch under a new one"}},"required":["tabId"],"additionalProperties":false},"CollaborationPresenceLeaveResponse":{"type":"object","properties":{"left":{"type":"boolean","description":"True when the member was shown and no live tab of theirs remains, so they stopped being shown; false when another live tab of theirs keeps them present, or they were not shown"}},"required":["left"],"additionalProperties":false},"BillingSummariesGetResponse":{"type":"object","properties":{"subscription":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["onboarding","active","trial","past_due","canceled","paused"]},"cancelAtPeriodEnd":{"type":"boolean"},"currentPeriodStart":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"currentPeriodEnd":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"renewsOn":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"endsOn":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"cancellable":{"type":"boolean"},"baseAmountCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"hasUsageLine":{"type":"boolean"}},"required":["id","status","cancelAtPeriodEnd","currentPeriodStart","currentPeriodEnd","renewsOn","endsOn","cancellable","baseAmountCents","hasUsageLine"],"additionalProperties":false},{"type":"null"}]},"marketplace":{"anyOf":[{"type":"object","properties":{"provider":{"type":"string","enum":["aws_marketplace","microsoft_marketplace","google_cloud_marketplace"]},"buyerAccountId":{"type":"string"},"purchaseId":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","enum":["active","waiting","ending","suspended"]},"termEnd":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"autoRenew":{"type":"boolean"},"manageUrl":{"type":"string","format":"uri"}},"required":["provider","buyerAccountId","purchaseId","status","termEnd","autoRenew","manageUrl"],"additionalProperties":false},{"type":"null"}]},"cardRemovalRefusal":{"anyOf":[{"type":"string","enum":["card_required_while_subscribed","card_required_while_usage_settles"]},{"type":"null"}]},"pendingCommand":{"anyOf":[{"type":"object","properties":{"billingProfileId":{"type":"string"},"operationId":{"type":"string"},"generation":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"command":{"anyOf":[{"type":"string","enum":["subscribe","cancel_at_period_end","undo_cancel","add_alpha","remove_alpha"]},{"type":"null"}]},"status":{"type":"string","enum":["pending","running","reconcile_required","payment_action_required","blocked"]},"customerActionCapability":{"anyOf":[{"type":"string","enum":["product.run","billing.manage"]},{"type":"null"}]}},"required":["billingProfileId","operationId","generation","command","status","customerActionCapability"],"additionalProperties":false},{"type":"null"}]},"refusal":{"anyOf":[{"type":"string","enum":["no_subscription","subscription_paused","subscription_canceled","billing_past_due","billing_suspended","billing_closed"]},{"type":"null"}]},"paymentDisputeHold":{"type":"boolean"},"invoiced":{"type":"boolean"},"notice":{"anyOf":[{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"ending"},"on":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"grace"},"until":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"invoiced":{"type":"boolean"}},"required":["kind","until","invoiced"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"payment_action_required"}},"required":["kind"],"additionalProperties":false}]},{"type":"null"}]},"collectionMethod":{"type":"string","enum":["charge_automatically","send_invoice"]},"invoiceTerms":{"type":"object","properties":{"request":{"anyOf":[{"type":"object","properties":{"status":{"type":"string","enum":["requested","approved","declined","withdrawn"]},"requestedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"decidedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"declineReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"application":{"anyOf":[{"type":"string","enum":["applying","applied","not_applied"]},{"type":"null"}]}},"required":["status","requestedAt","decidedAt","declineReason","application"],"additionalProperties":false},{"type":"null"}]},"daysUntilDue":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"creditLimitCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"openBalanceCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"pending":{"type":"boolean"}},"required":["request","daysUntilDue","creditLimitCents","openBalanceCents","pending"],"additionalProperties":false},"card":{"anyOf":[{"type":"object","properties":{"brand":{"anyOf":[{"type":"string"},{"type":"null"}]},"last4":{"anyOf":[{"type":"string"},{"type":"null"}]},"expMonth":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"expYear":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"walletType":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["brand","last4","expMonth","expYear","walletType"],"additionalProperties":false},{"type":"null"}]},"tax":{"anyOf":[{"type":"object","properties":{"locationStatus":{"anyOf":[{"type":"string","enum":["supported","not_collecting","unrecognized_location","failed"]},{"type":"null"}]},"locationRequired":{"type":"boolean"},"exempt":{"type":"string","enum":["none","exempt","reverse"]}},"required":["locationStatus","locationRequired","exempt"],"additionalProperties":false},{"type":"null"}]},"hasBillingProfile":{"type":"boolean"},"invoices":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"description":{"type":"string"},"status":{"type":"string","enum":["open","paid","void","uncollectible"]},"amountPaidCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"amountDueCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"creditAppliedCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"periodEnd":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"hostedInvoiceUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Stripe's hosted page: pay an open invoice, or read a settled one. Anyone holding the link can open it, so only a dashboard session receives it; null for API key, OAuth, and MCP callers."},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"number":{"anyOf":[{"type":"string"},{"type":"null"}]},"collectionMethod":{"anyOf":[{"type":"string","enum":["charge_automatically","send_invoice"]},{"type":"null"}]},"dueAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"amountRemainingCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"taxCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["id","description","status","amountPaidCents","amountDueCents","creditAppliedCents","periodEnd","hostedInvoiceUrl","createdAt","number","collectionMethod","dueAt","amountRemainingCents","taxCents"],"additionalProperties":false}},"invoiceBeingFinalized":{"anyOf":[{"type":"object","properties":{"periodStart":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"periodEnd":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]}},"required":["periodStart","periodEnd"],"additionalProperties":false},{"type":"null"}]},"creditGrants":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"code":{"anyOf":[{"type":"string"},{"type":"null"}]},"creditCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"redeemedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"appliedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]}},"required":["id","code","creditCents","redeemedAt","appliedAt"],"additionalProperties":false}},"creditBalanceCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"basePriceCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"hasMoreInvoices":{"type":"boolean"},"nextInvoiceCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"hasMoreCreditGrants":{"type":"boolean"}},"required":["subscription","marketplace","cardRemovalRefusal","pendingCommand","refusal","paymentDisputeHold","invoiced","notice","collectionMethod","invoiceTerms","card","tax","hasBillingProfile","invoices","invoiceBeingFinalized","creditGrants","creditBalanceCents","basePriceCents","hasMoreInvoices","nextInvoiceCursor","hasMoreCreditGrants"],"additionalProperties":false},"BillingUsageSummariesGetResponse":{"type":"object","properties":{"observedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"period":{"anyOf":[{"type":"object","properties":{"start":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"end":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"prorated":{"type":"boolean"}},"required":["start","end","prorated"],"additionalProperties":false},{"type":"null"}]},"usage":{"$ref":"#/components/schemas/BillingUsage"},"overageUsdSettledThisPeriod":{"type":"string"},"pendingRuns":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"billedThroughMarketplace":{"type":"boolean"},"overageTerms":{"type":"object","properties":{"acceptedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"orderFormReference":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["acceptedAt","orderFormReference"],"additionalProperties":false}},"required":["observedAt","period","usage","overageUsdSettledThisPeriod","pendingRuns","billedThroughMarketplace","overageTerms"],"additionalProperties":false},"BillingUsageSummariesGetV2Response":{"type":"object","properties":{"observedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"period":{"anyOf":[{"type":"object","properties":{"start":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"end":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"prorated":{"type":"boolean"}},"required":["start","end","prorated"],"additionalProperties":false},{"type":"null"}]},"usage":{"$ref":"#/components/schemas/BillingUsage"},"overageUsdSettledThisPeriod":{"type":"string"},"pendingRuns":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"billedThroughMarketplace":{"type":"boolean"}},"required":["observedAt","period","usage","overageUsdSettledThisPeriod","pendingRuns","billedThroughMarketplace"],"additionalProperties":false},"BillingUsageSummariesGetV3Response":{"type":"object","properties":{"observedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"period":{"anyOf":[{"type":"object","properties":{"start":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"end":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"prorated":{"type":"boolean"}},"required":["start","end","prorated"],"additionalProperties":false},{"type":"null"}]},"usage":{"type":"array","items":{"type":"object","properties":{"identity":{"type":"string"},"productSlug":{"type":"string"},"dimensionKey":{"type":"string"},"unitPriceCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"included":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"used":{"type":"number","minimum":0},"held":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"remaining":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"overageUnits":{"type":"number","minimum":0},"overageUsd":{"type":"string"},"pending":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"share":{"type":"number"},"productName":{"anyOf":[{"type":"string"},{"type":"null"}]},"productId":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"type":"object","properties":{"singular":{"type":"string"},"plural":{"type":"string"}},"required":["singular","plural"],"additionalProperties":false},"placement":{"type":"string","enum":["campaigns","alpha","other"]},"unit":{"type":"string","enum":["count","usd"]},"usedQuantity":{"type":"string","pattern":"^\\d+\\.\\d{6}$"},"overageQuantity":{"type":"string","pattern":"^\\d+\\.\\d{6}$"}},"required":["identity","productSlug","dimensionKey","unitPriceCents","included","used","held","remaining","overageUnits","overageUsd","pending","share","productName","productId","label","placement","unit","usedQuantity","overageQuantity"],"additionalProperties":false}},"overageUsdSettledThisPeriod":{"type":"string"},"pendingRuns":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"billedThroughMarketplace":{"type":"boolean"},"unbilledUsage":{"anyOf":[{"type":"object","properties":{"overageCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"invoicedOn":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"invoicedEarlyAtCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["overageCents","invoicedOn","invoicedEarlyAtCents"],"additionalProperties":false},{"type":"null"}]}},"required":["observedAt","period","usage","overageUsdSettledThisPeriod","pendingRuns","billedThroughMarketplace","unbilledUsage"],"additionalProperties":false},"BillingInteractionAdmissionsListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"identity":{"type":"string"},"admission":{"anyOf":[{"type":"object","properties":{"disposition":{"type":"string","enum":["included","overage"]},"refusal":{"type":"null"},"message":{"type":"null"}},"required":["disposition","refusal","message"],"additionalProperties":false},{"type":"object","properties":{"disposition":{"type":"string","const":"overage"},"refusal":{"type":"string","enum":["no_subscription","subscription_paused","subscription_canceled","billing_past_due","billing_suspended","billing_closed","interaction_unavailable","interaction_overage_disabled","interaction_held_by_turn","interaction_usage_pending","spend_ceiling_exceeded"]},"message":{"type":"string"}},"required":["disposition","refusal","message"],"additionalProperties":false}]}},"required":["identity","admission"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"BillingBillingDetailsGetResponse":{"type":"object","properties":{"billingEmail":{"anyOf":[{"type":"string"},{"type":"null"}]},"billingContactName":{"anyOf":[{"type":"string"},{"type":"null"}]},"billingContactTitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"billingPhone":{"anyOf":[{"type":"string"},{"type":"null"}]},"billingLegalName":{"anyOf":[{"type":"string"},{"type":"null"}]},"billingAddressLine1":{"anyOf":[{"type":"string"},{"type":"null"}]},"billingAddressLine2":{"anyOf":[{"type":"string"},{"type":"null"}]},"billingCity":{"anyOf":[{"type":"string"},{"type":"null"}]},"billingState":{"anyOf":[{"type":"string"},{"type":"null"}]},"billingPostalCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"billingCountry":{"anyOf":[{"type":"string"},{"type":"null"}]},"billingPoNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"billingTaxIdType":{"anyOf":[{"type":"string"},{"type":"null"}]},"billingTaxId":{"anyOf":[{"type":"string"},{"type":"null"}]},"revision":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"syncedToStripe":{"type":"boolean"}},"required":["billingEmail","billingContactName","billingContactTitle","billingPhone","billingLegalName","billingAddressLine1","billingAddressLine2","billingCity","billingState","billingPostalCode","billingCountry","billingPoNumber","billingTaxIdType","billingTaxId","revision","syncedToStripe"],"additionalProperties":false},"AccountMembersListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["member","invitation"]},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"userId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"email":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"imageUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"role":{"type":"string","enum":["owner","admin","editor","viewer"]},"status":{"type":"string","enum":["active","pending","pending_email_failed","expired"]},"deliveryOperationId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"ownershipHandoff":{"type":"boolean","description":"An invitation whose acceptance makes the invitee the organization's owner in place of the owner who sent it; `role` is what it records until then. Always false for a member"}},"required":["kind","id","userId","email","name","imageUrl","role","status","deliveryOperationId","ownershipHandoff"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"ownerCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["data","nextCursor","ownerCount"],"additionalProperties":false},"AccountMembersDeleteRequest":{"type":"object","properties":{"membershipId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["membershipId"],"additionalProperties":false},"AccountMembersDeleteResponse":{"type":"object","properties":{"membershipId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"remainingReachability":{"type":"string","enum":["none","manager_grant"]},"revokedApiKeys":{"type":"integer","minimum":0,"maximum":9007199254740991},"activeApiKeysCreatedByTarget":{"type":"integer","minimum":0,"maximum":9007199254740991},"revokedCrmConnections":{"type":"integer","minimum":0,"maximum":9007199254740991},"revokedGoogleAdsConnections":{"type":"integer","minimum":0,"maximum":9007199254740991},"revokedOutcomeConnections":{"type":"integer","minimum":0,"maximum":9007199254740991},"endedPagePublications":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["membershipId","remainingReachability","revokedApiKeys","activeApiKeysCreatedByTarget","revokedCrmConnections","revokedGoogleAdsConnections","revokedOutcomeConnections","endedPagePublications"],"additionalProperties":false},"AccountMembershipsLeaveRequest":{"type":"object","properties":{},"additionalProperties":false},"AccountMembershipsLeaveResponse":{"type":"object","properties":{"membershipId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revokedApiKeys":{"type":"integer","minimum":0,"maximum":9007199254740991},"revokedCrmConnections":{"type":"integer","minimum":0,"maximum":9007199254740991},"revokedGoogleAdsConnections":{"type":"integer","minimum":0,"maximum":9007199254740991},"revokedOutcomeConnections":{"type":"integer","minimum":0,"maximum":9007199254740991},"endedPagePublications":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["membershipId","revokedApiKeys","revokedCrmConnections","revokedGoogleAdsConnections","revokedOutcomeConnections","endedPagePublications"],"additionalProperties":false},"AccountPartnerAccessListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["partner","request"]},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"A partner's access id (for account_partner_access_revoke), or a request's id (for account_partner_link_requests_approve and account_partner_link_requests_decline)"},"managerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","description":"The partner firm's name"},"partnerId":{"type":"string","description":"The firm's 10-digit Partner ID, bare digits"},"at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"When the firm was given access, or when it asked"},"expiresAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}],"description":"When an unanswered request lapses; null for a partner"},"requestedBy":{"anyOf":[{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"type":"string"}},"required":["name","email"],"additionalProperties":false},{"type":"null"}],"description":"Who at the firm asked; null for a partner"},"people":{"type":"array","items":{"type":"object","properties":{"userId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"type":"string"},"managerRole":{"type":"string","enum":["owner","admin","editor","viewer"],"description":"Their role at the partner firm"},"clientRole":{"type":"string","enum":["admin","editor","viewer","none"],"description":"The access the firm gives them in its clients; none reaches no client"},"effectiveRole":{"anyOf":[{"type":"string","enum":["owner","admin","editor","viewer"]},{"type":"null"}],"description":"What they can do in this organization now, through any membership or partner; null when they cannot reach it"}},"required":["userId","name","email","managerRole","clientRole","effectiveRole"],"additionalProperties":false},"description":"The firm's people: who has access through it, or would once approved"}},"required":["kind","id","managerId","name","partnerId","at","expiresAt","requestedBy","people"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"AccountPartnerAccessRevokeRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The partner's access id"}},"required":["id"],"additionalProperties":false},"AccountPartnerAccessRevokeResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revoked":{"type":"boolean","const":true},"revokedApiKeys":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"API keys the firm's people created here that this removal revoked"}},"required":["id","revoked","revokedApiKeys"],"additionalProperties":false},"AccountPartnerLinkRequestsDeclineRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The request's id"}},"required":["id"],"additionalProperties":false},"AccountPartnerLinkRequestsDeclineResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"status":{"type":"string","const":"declined"}},"required":["id","status"],"additionalProperties":false},"AccountPartnerManagementGetResponse":{"type":"object","properties":{"designation":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The designation's id, for account_partner_management_revoke"},"managerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","description":"The partner firm's name"},"partnerId":{"type":"string","description":"The firm's 10-digit Partner ID, bare digits"},"source":{"type":"string","enum":["customer","written_confirmation"],"description":"customer: the organization's own owner or admin designated it here; written_confirmation: Point11 recorded the organization's written confirmation"},"representativeName":{"type":"string","description":"Who designated the firm for the organization"},"receivedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"When Point11 received the designation"},"effectiveAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"When it took, or takes, effect"}},"required":["id","managerId","name","partnerId","source","representativeName","receivedAt","effectiveAt"],"additionalProperties":false},{"type":"null"}],"description":"The firm designated now; null when none is"},"candidates":{"type":"array","items":{"type":"object","properties":{"managerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","description":"The partner firm's name"},"partnerId":{"type":"string","description":"The firm's 10-digit Partner ID, bare digits"}},"required":["managerId","name","partnerId"],"additionalProperties":false},"description":"The firms the organization may designate: partner firms that can work in it, or that brought it to Point11"},"acknowledgment":{"type":"object","properties":{"text":{"type":"string","description":"The standard confirmation a designation acknowledges"},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$","description":"Its SHA-256, for account_partner_management_designate"}},"required":["text","sha256"],"additionalProperties":false}},"required":["designation","candidates","acknowledgment"],"additionalProperties":false},"AccountPartnerManagementDesignateRequest":{"type":"object","properties":{"managerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The firm's managerId, from account_partner_management_get"},"acknowledgmentSha256":{"type":"string","pattern":"^[a-f0-9]{64}$","description":"The standard confirmation's sha256 from account_partner_management_get, which the user acknowledges"}},"required":["managerId","acknowledgmentSha256"],"additionalProperties":false},"AccountPartnerManagementDesignateResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"designated":{"type":"boolean","const":true}},"required":["id","designated"],"additionalProperties":false},"AccountPartnerManagementRevokeRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The designation's id"}},"required":["id"],"additionalProperties":false},"AccountPartnerManagementRevokeResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revoked":{"type":"boolean","const":true}},"required":["id","revoked"],"additionalProperties":false},"AccountInvitationsListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"email":{"type":"string"},"role":{"type":"string","enum":["admin","editor","viewer"]},"status":{"type":"string","enum":["pending","pending_email_failed","expired"]},"deliveryOperationId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"expiresAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"ownershipHandoff":{"type":"boolean","description":"Acceptance makes the invitee the organization's owner in place of the owner who sent it; `role` is what it records until then"}},"required":["id","email","role","status","deliveryOperationId","expiresAt","ownershipHandoff"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"AccountInvitationsCreateRequest":{"type":"object","properties":{"email":{"type":"string"},"role":{"type":"string","enum":["admin","editor","viewer"]},"message":{"type":"string"}},"required":["email","role"],"additionalProperties":false},"AccountInvitationsCreateResponse":{"type":"object","properties":{"invitationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"email":{"type":"string"},"delivery":{"$ref":"#/components/schemas/AccountDelivery"}},"required":["invitationId","email","delivery"],"additionalProperties":false},"AccountInvitationsResendRequest":{"type":"object","properties":{"invitationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["invitationId"],"additionalProperties":false},"AccountInvitationsResendResponse":{"type":"object","properties":{"invitationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"email":{"type":"string"},"delivery":{"$ref":"#/components/schemas/AccountDelivery"}},"required":["invitationId","email","delivery"],"additionalProperties":false},"AccountInvitationsRevokeRequest":{"type":"object","properties":{"invitationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["invitationId"],"additionalProperties":false},"AccountInvitationsRevokeResponse":{"type":"object","properties":{"invitationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"email":{"type":"string"},"role":{"type":"string","enum":["admin","editor","viewer"]}},"required":["invitationId","email","role"],"additionalProperties":false},"AccountOrganizationsGetResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"orgNumber":{"type":"string","description":"The 10-digit organization number, as bare digits"},"timezone":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"IANA time zone; null while unset (read as UTC)"}},"required":["id","name","orgNumber","timezone"],"additionalProperties":false},"AccountOrganizationsUpdateRequest":{"type":"object","properties":{"name":{"type":"string"},"timezone":{"type":"string"}},"additionalProperties":false},"AccountOrganizationsUpdateResponse":{"type":"object","properties":{"name":{"type":"string"},"timezone":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["name","timezone"],"additionalProperties":false},"AccountAiInferenceSettingsGetResponse":{"type":"object","properties":{"executionPolicy":{"type":"object","properties":{"executionTarget":{"type":"string","enum":["automatic","bedrock","azure","vertex"]},"credentialRequirement":{"type":"string","enum":["any","byok"]}},"required":["executionTarget","credentialRequirement"],"additionalProperties":false},"dataPolicy":{"type":"string","enum":["standard","no-training"]},"credentialStorageAvailable":{"type":"boolean"},"credentialTestModels":{"type":"object","additionalProperties":false,"required":["bedrock","azure","vertex"],"properties":{"bedrock":{"type":"string"},"azure":{"type":"string"},"vertex":{"type":"string"}}},"customerCredential":{"anyOf":[{"type":"object","properties":{"credentialVersionId":{"type":"string"},"provider":{"type":"string","enum":["bedrock","azure","vertex"]},"label":{"type":"string"},"status":{"type":"string","enum":["verified","failed"]},"verifiedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"lastTestedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"lastTestFailureCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["credentialVersionId","provider","label","status","verifiedAt","lastTestedAt","lastTestFailureCode","updatedAt"],"additionalProperties":false},{"type":"null"}]},"customerCredentialUsage":{"type":"object","properties":{"verifiedCalls":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"verifiedInputTokens":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"verifiedOutputTokens":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"point11FallbackCalls":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unresolvedRecords":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"pendingCalls":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"periodStart":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"providers":{"readOnly":true,"type":"array","items":{"type":"object","properties":{"provider":{"type":"string","enum":["bedrock","azure","vertex"]},"verifiedCalls":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"verifiedInputTokens":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"verifiedOutputTokens":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"point11FallbackCalls":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unresolvedRecords":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"pendingCalls":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["provider","verifiedCalls","verifiedInputTokens","verifiedOutputTokens","point11FallbackCalls","unresolvedRecords","pendingCalls"],"additionalProperties":false}},"credentialVersions":{"readOnly":true,"type":"array","items":{"type":"object","properties":{"credentialVersionId":{"anyOf":[{"type":"string"},{"type":"null"}]},"provider":{"type":"string","enum":["bedrock","azure","vertex"]},"accountLabel":{"anyOf":[{"type":"string"},{"type":"null"}]},"current":{"type":"boolean"},"verifiedCalls":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"verifiedInputTokens":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"verifiedOutputTokens":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"point11FallbackCalls":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unresolvedRecords":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"pendingCalls":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["credentialVersionId","provider","accountLabel","current","verifiedCalls","verifiedInputTokens","verifiedOutputTokens","point11FallbackCalls","unresolvedRecords","pendingCalls"],"additionalProperties":false}}},"required":["verifiedCalls","verifiedInputTokens","verifiedOutputTokens","point11FallbackCalls","unresolvedRecords","pendingCalls","periodStart","providers","credentialVersions"],"additionalProperties":false}},"required":["executionPolicy","dataPolicy","credentialStorageAvailable","credentialTestModels","customerCredential","customerCredentialUsage"],"additionalProperties":false},"AccountNotificationPreferencesListV2Response":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"category":{"type":"string","enum":["onboarding","advisor","research","experience","campaigns"]},"label":{"type":"string"},"description":{"type":"string"},"enabled":{"type":"boolean"}},"required":["category","label","description","enabled"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"AccountNotificationPreferencesListV3Response":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"category":{"type":"string","enum":["mentions","new-members","onboarding","advisor","research","experience","campaigns"]},"label":{"type":"string"},"description":{"type":"string"},"enabled":{"type":"boolean"},"channels":{"type":"object","properties":{"slack":{"type":"object","properties":{"enabled":{"type":"boolean","description":"True while the member receives this category on the channel"},"available":{"type":"boolean","description":"False while the channel cannot deliver to this organization; its switch is off"}},"required":["enabled","available"],"additionalProperties":false},"teams":{"type":"object","properties":{"enabled":{"type":"boolean","description":"True while the member receives this category on the channel"},"available":{"type":"boolean","description":"False while the channel cannot deliver to this organization; its switch is off"}},"required":["enabled","available"],"additionalProperties":false}},"required":["slack","teams"],"additionalProperties":false,"description":"The category on each chat channel in the caller's organization; `enabled` above is email"}},"required":["category","label","description","enabled","channels"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"AccountNotificationPreferencesListV4Response":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"category":{"type":"string","enum":["mentions","new-members","onboarding","advisor","research","experience","campaigns"]},"label":{"type":"string"},"description":{"type":"string"},"channels":{"type":"object","properties":{"email":{"type":"object","properties":{"enabled":{"type":"boolean","description":"True while the member receives this category on the channel"},"default":{"type":"boolean","description":"What the member receives on the channel until they choose: the category's default"},"available":{"type":"boolean","description":"False while the channel cannot deliver to this organization; its switch is off"}},"required":["enabled","default","available"],"additionalProperties":false},"slack":{"type":"object","properties":{"enabled":{"type":"boolean","description":"True while the member receives this category on the channel"},"default":{"type":"boolean","description":"What the member receives on the channel until they choose: the category's default"},"available":{"type":"boolean","description":"False while the channel cannot deliver to this organization; its switch is off"}},"required":["enabled","default","available"],"additionalProperties":false}},"required":["email","slack"],"additionalProperties":false,"description":"The category on each channel in the caller's organization"}},"required":["category","label","description","channels"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"AccountNotificationPreferencesUpdateRequest":{"type":"object","properties":{"category":{"type":"string"},"enabled":{"type":"boolean"},"channel":{"description":"The channel to switch; email when omitted","type":"string","enum":["email","slack","teams"]}},"required":["category","enabled"],"additionalProperties":false,"deprecated":true},"AccountNotificationPreferencesUpdateResponse":{"type":"object","properties":{"category":{"type":"string"},"enabled":{"type":"boolean"}},"required":["category","enabled"],"additionalProperties":false},"AccountNotificationPreferencesUpdateV2Request":{"type":"object","properties":{"category":{"type":"string","enum":["mentions","new-members","onboarding","advisor","research","experience","campaigns"]},"channel":{"type":"string","enum":["email","slack"],"description":"The channel to switch"},"enabled":{"type":"boolean"}},"required":["category","channel","enabled"],"additionalProperties":false},"AccountNotificationPreferencesUpdateV2Response":{"type":"object","properties":{"category":{"type":"string","enum":["mentions","new-members","onboarding","advisor","research","experience","campaigns"]},"channel":{"type":"string","enum":["email","slack"]},"enabled":{"type":"boolean"}},"required":["category","channel","enabled"],"additionalProperties":false},"AccountAuditLogEntriesListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"action":{"type":"string"},"actorType":{"type":"string","enum":["user","api_key","system","webhook"]},"actorId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The acting user's id; null for an API key, the system, or Point11 support"},"actedBy":{"anyOf":[{"type":"string","enum":["Point11 support (View as)","Point11 support"]},{"type":"null"}],"description":"\"Point11 support (View as)\" when Point11 support made this change while viewing as the actor; \"Point11 support\" when Point11 support made it from Point11's own console; otherwise null"},"targetType":{"anyOf":[{"type":"string"},{"type":"null"}]},"targetId":{"anyOf":[{"type":"string"},{"type":"null"}]},"targetEmail":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The address a member or invitation target holds now, read with the entry: the member's while their account is live, and an invitation's while it is pending or a live account holds its address; null for every other target, once that account is closing, and for the address of Point11 staff who were never a member"},"door":{"anyOf":[{"type":"string","enum":["session","rest","mcp","agent","operator"]},{"type":"null"}],"description":"How the change was made: the dashboard (session), the REST API (rest), MCP (mcp), a Point11 AI assistant acting for the actor (agent) or Point11's operator console (operator); null for an entry made outside an operation, by the system, or before doors were recorded"},"oauthClientId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The OAuth client id of the AI client or app the actor acted through (see account_connected_apps_list); null for every other entry"},"ipAddress":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The request's IP address; null when Point11 support made the change, and on a sign-in entry (an `auth.` action) read while Point11 support is viewing as a member"},"metadata":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/JsonValue"}},{"type":"null"}]}},"required":["id","createdAt","action","actorType","actorId","actedBy","targetType","targetId","targetEmail","door","oauthClientId","ipAddress","metadata"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"AccountBrandingGetResponse":{"type":"object","properties":{"branding":{"anyOf":[{"$ref":"#/components/schemas/AccountBranding"},{"type":"null"}]},"logo":{"anyOf":[{"type":"object","properties":{"url":{"type":"string"},"monochrome":{"type":"boolean"}},"required":["url","monochrome"],"additionalProperties":false},{"type":"null"}]}},"required":["branding","logo"],"additionalProperties":false},"AccountBrandingGetV2Response":{"type":"object","properties":{"branding":{"anyOf":[{"$ref":"#/components/schemas/AccountBranding2"},{"type":"null"}]},"logo":{"anyOf":[{"type":"object","properties":{"url":{"type":"string"},"monochrome":{"type":"boolean"}},"required":["url","monochrome"],"additionalProperties":false},{"type":"null"}]}},"required":["branding","logo"],"additionalProperties":false},"AccountBrandingUpdateRequest":{"type":"object","properties":{"logoUrl":{"anyOf":[{"type":"string","maxLength":2000,"format":"uri"},{"type":"null"}]},"faviconUrl":{"anyOf":[{"type":"string","maxLength":2000,"format":"uri"},{"type":"null"}]},"primaryColor":{"anyOf":[{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},{"type":"null"}]},"accentColor":{"anyOf":[{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},{"type":"null"}]},"fontFamily":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"customCss":{"anyOf":[{"type":"string","maxLength":50000},{"type":"null"}]},"widgetPosition":{"type":"string","enum":["bottom-right","bottom-left","top-right","top-left"]},"widgetGreeting":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]}},"additionalProperties":false,"deprecated":true},"AccountBrandingUpdateResponse":{"type":"object","properties":{"branding":{"$ref":"#/components/schemas/AccountBranding"}},"required":["branding"],"additionalProperties":false},"AccountBrandingUpdateV2Request":{"type":"object","properties":{"primaryColor":{"anyOf":[{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},{"type":"null"}]},"accentColor":{"anyOf":[{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},{"type":"null"}]},"fontFamily":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"customCss":{"anyOf":[{"type":"string","maxLength":50000},{"type":"null"}]},"widgetPosition":{"type":"string","enum":["bottom-right","bottom-left","top-right","top-left"]},"widgetGreeting":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]}},"additionalProperties":false},"AccountBrandingUpdateV2Response":{"type":"object","properties":{"branding":{"$ref":"#/components/schemas/AccountBranding2"}},"required":["branding"],"additionalProperties":false},"AccountOrganizationLogosDeleteRequest":{"type":"object","properties":{},"additionalProperties":false},"AccountOrganizationLogosDeleteResponse":{"type":"object","properties":{"removed":{"type":"boolean","description":"Whether a logo was set and is now removed"}},"required":["removed"],"additionalProperties":false},"AccountOrganizationLogosUpdateRequest":{"type":"object","properties":{"image":{"type":"string","minLength":1,"maxLength":2796204,"format":"base64","contentEncoding":"base64","pattern":"^$|^(?:[0-9a-zA-Z+/]{4})*(?:(?:[0-9a-zA-Z+/]{2}==)|(?:[0-9a-zA-Z+/]{3}=))?$","description":"The image file's bytes, base64-encoded; at most 2 MB decoded"},"contentType":{"type":"string","enum":["image/jpeg","image/png","image/webp","image/gif","image/avif","image/tiff","image/svg+xml"],"description":"The image's media type"}},"required":["image","contentType"],"additionalProperties":false},"AccountOrganizationLogosUpdateResponse":{"type":"object","properties":{"url":{"type":"string"},"monochrome":{"type":"boolean"}},"required":["url","monochrome"],"additionalProperties":false},"AccountInvitationsAcceptRequest":{"type":"object","properties":{"invitationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The invitation to accept"}},"required":["invitationId"],"additionalProperties":false},"AccountInvitationsAcceptResponse":{"type":"object","properties":{"organizationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The organization joined"},"invitationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"role":{"type":"string","enum":["owner","admin","editor","viewer"],"description":"The person's role there: the invitation's, or the one they already held"}},"required":["organizationId","invitationId","role"],"additionalProperties":false},"AccountPendingInvitationsListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"organizationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"organizationName":{"type":"string"},"role":{"type":"string","enum":["admin","editor","viewer"]},"invitedBy":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The inviter's name, else their email; null once their account is gone"},"expiresAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"singleSignOnRequired":{"type":"boolean","description":"The organization requires single sign-on for this address: join by signing in through it"}},"required":["id","organizationId","organizationName","role","invitedBy","expiresAt","singleSignOnRequired"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"AccountSessionsListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"device":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The browser and operating system the session signed in from, such as \"Chrome on macOS\"; null when its sign-in recorded none"},"deviceKind":{"anyOf":[{"type":"string","enum":["phone","tablet","computer"]},{"type":"null"}],"description":"What kind of device the session signed in from; null when its sign-in named none"},"ipAddress":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The address the session signed in from"},"location":{"anyOf":[{"type":"object","properties":{"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"region":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The region part of its ISO 3166-2 code, such as \"IL\""},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Its ISO 3166-1 alpha-2 code, such as \"US\""}},"required":["city","region","country"],"additionalProperties":false},{"type":"null"}],"description":"Where the session signed in from, as Vercel's network placed its address at sign-in; null when it was not placed"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"When the person signed in"},"expiresAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"current":{"type":"boolean","description":"This device: the session the call itself was made from"},"method":{"anyOf":[{"type":"string","enum":["email","google","microsoft","sso"]},{"type":"null"}],"description":"How the person signed in: an emailed code, Google, Microsoft or single sign-on"}},"required":["id","device","deviceKind","ipAddress","location","createdAt","expiresAt","current","method"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"AccountSessionsListV2Response":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"device":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The browser and operating system the session signed in from, such as \"Chrome on macOS\"; null when its sign-in recorded none"},"deviceKind":{"anyOf":[{"type":"string","enum":["phone","tablet","computer"]},{"type":"null"}],"description":"What kind of device the session signed in from; null when its sign-in named none"},"ipAddress":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The address the session signed in from"},"location":{"anyOf":[{"type":"object","properties":{"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"region":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The region part of its ISO 3166-2 code, such as \"IL\""},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Its ISO 3166-1 alpha-2 code, such as \"US\""}},"required":["city","region","country"],"additionalProperties":false},{"type":"null"}],"description":"Where the session signed in from, as Vercel's network placed its address at sign-in; null when it was not placed"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"When the person signed in"},"expiresAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"current":{"type":"boolean","description":"This device: the session the call itself was made from"},"method":{"anyOf":[{"type":"string","enum":["email","passkey","google","microsoft","sso"]},{"type":"null"}],"description":"How the person signed in: an emailed code, a passkey, Google, Microsoft or single sign-on"}},"required":["id","device","deviceKind","ipAddress","location","createdAt","expiresAt","current","method"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"AccountMfaFactorsListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"totp","description":"An authenticator app; WorkOS offers no other factor here"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"When the app was added"}},"required":["id","type","createdAt"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"recoveryCodesRemaining":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"How many of the person's recovery codes are still unused"}},"required":["data","nextCursor","recoveryCodesRemaining"],"additionalProperties":false},"AccountMfaFactorsListV2Response":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"kind":{"type":"string","enum":["passkey","totp","sms"],"description":"A passkey or security key, an authenticator app, or a text-message number"},"name":{"type":"string","description":"What the person calls it"},"isDefault":{"type":"boolean","description":"Whether sign-in asks for this method first"},"phoneHint":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A text-message number's last digits; null for any other method"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"When the method was added"},"lastUsedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}],"description":"When it last answered a second step"},"deviceBound":{"type":"boolean","description":"Whether it is a passkey its authenticator reports can't sync, such as a security key; false for any other method"},"provider":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A passkey's provider, such as Google Password Manager or 1Password, when its model names one; null otherwise"},"credentialId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A passkey's credential id, base64url, as the browser's WebAuthn Signal API names it; null for any other method"}},"required":["id","kind","name","isDefault","phoneHint","createdAt","lastUsedAt","deviceBound","provider","credentialId"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"recoveryCodesRemaining":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"How many of the person's recovery codes are still unused"}},"required":["data","nextCursor","recoveryCodesRemaining"],"additionalProperties":false},"AccountTrustedBrowsersListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":{"type":"string","description":"The browser and system it was trusted on"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"When it was trusted"},"expiresAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"When its trust ends"},"lastUsedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}],"description":"When it last skipped the second step"}},"required":["id","description","createdAt","expiresAt","lastUsedAt"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"AccountTwoStepPolicyGetResponse":{"type":"object","properties":{"required":{"type":"boolean","description":"Whether every member must have two-step verification"},"graceEndsAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}],"description":"While required: when members without it stop being let in"},"allowedMethods":{"minItems":1,"type":"array","items":{"type":"string","enum":["passkey","totp","sms"]},"description":"The methods that satisfy the requirement"},"trustedBrowserDays":{"anyOf":[{"type":"number","const":0},{"type":"number","const":7},{"type":"number","const":30}],"description":"How many days a trusted browser may skip the second step here; 0 trusts none"},"recoveryCodesCount":{"type":"boolean","description":"Whether a recovery code satisfies the requirement"},"deviceBoundPasskeys":{"type":"boolean","description":"Whether only a passkey that can't sync, by its authenticator's own unattested report (such as a security key), counts as a passkey"},"maxSessionHours":{"anyOf":[{"type":"number","enum":[8,12,24,72]},{"type":"null"}],"description":"How many hours one sign-in may act here; null is WorkOS's 7 days"},"apiKeyMaxDays":{"anyOf":[{"type":"number","enum":[30,90,180]},{"type":"null"}],"description":"How many days a new API key may live; null is a year"}},"required":["required","graceEndsAt","allowedMethods","trustedBrowserDays","recoveryCodesCount","deviceBoundPasskeys","maxSessionHours","apiKeyMaxDays"],"additionalProperties":false},"AccountTwoStepMembersListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The member's user id"},"email":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"role":{"type":"string"},"twoStep":{"type":"boolean","description":"Whether they have two-step verification on"}},"required":["id","email","name","role","twoStep"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"AccountTwoStepMembersListV2Response":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The member's user id"},"email":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"role":{"type":"string"},"hasTwoStep":{"type":"boolean","description":"Whether they have two-step verification on"},"methodKinds":{"type":"array","items":{"type":"string","enum":["passkey","security_key","totp","sms"]},"description":"The kinds of method they hold: a passkey, security_key (a passkey its authenticator reports can't sync, such as a security key), an authenticator app (totp) or a text message (sms)"},"phishingResistant":{"type":"boolean","description":"Whether they hold a passkey or security key, which a phishing page cannot relay"},"ssoExempt":{"type":"boolean","description":"Whether their address is on one of the organization's verified single sign-on domains, so they sign in through its connection, whose identity provider asks its own second step"},"lastAnsweredAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}],"description":"When any of their methods last answered a second step"},"trustedBrowsers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"How many browsers they trust to skip the second step now"},"apiKeysWithoutTwoStep":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"How many of the organization's live API keys they created without a second step; the requirement refuses them once its grace period ends"}},"required":["id","email","name","role","hasTwoStep","methodKinds","phishingResistant","ssoExempt","lastAnsweredAt","trustedBrowsers","apiKeysWithoutTwoStep"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"AccountSignInHistoryListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"signedInAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"method":{"anyOf":[{"type":"string","enum":["email","google","microsoft","sso"]},{"type":"null"}],"description":"How the person signed in: an emailed code, Google, Microsoft or single sign-on"},"ipAddress":{"anyOf":[{"type":"string"},{"type":"null"}]},"device":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The browser and operating system the user agent names, such as \"Chrome on macOS\""},"userAgent":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","signedInAt","method","ipAddress","device","userAgent"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"AccountSignInHistoryListV2Response":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"signedInAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"method":{"anyOf":[{"type":"string","enum":["email","passkey","google","microsoft","sso"]},{"type":"null"}],"description":"How the person signed in: an emailed code, a passkey, Google, Microsoft or single sign-on"},"ipAddress":{"anyOf":[{"type":"string"},{"type":"null"}]},"device":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The browser and operating system the user agent names, such as \"Chrome on macOS\""},"userAgent":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","signedInAt","method","ipAddress","device","userAgent"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"AccountMemberSignInsListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"signedInAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"method":{"anyOf":[{"type":"string","enum":["email","google","microsoft","sso"]},{"type":"null"}],"description":"How the person signed in: an emailed code, Google, Microsoft or single sign-on"},"ipAddress":{"anyOf":[{"type":"string"},{"type":"null"}]},"device":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The browser and operating system the user agent names, such as \"Chrome on macOS\""},"userAgent":{"anyOf":[{"type":"string"},{"type":"null"}]},"userId":{"type":"string","description":"The member's user id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"type":"string"}},"required":["id","signedInAt","method","ipAddress","device","userAgent","userId","name","email"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"AccountMemberSignInsListV2Response":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"signedInAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"method":{"anyOf":[{"type":"string","enum":["email","passkey","google","microsoft","sso"]},{"type":"null"}],"description":"How the person signed in: an emailed code, a passkey, Google, Microsoft or single sign-on"},"ipAddress":{"anyOf":[{"type":"string"},{"type":"null"}]},"device":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The browser and operating system the user agent names, such as \"Chrome on macOS\""},"userAgent":{"anyOf":[{"type":"string"},{"type":"null"}]},"userId":{"type":"string","description":"The member's user id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"type":"string"}},"required":["id","signedInAt","method","ipAddress","device","userAgent","userId","name","email"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"AccountSupportAccessSettingsGetResponse":{"type":"object","properties":{"mode":{"type":"string","enum":["notify","approval"],"description":"Governs only Point11 support viewing the app as one of your members. notify: the owners are emailed each time support starts such a view; approval: support may start one only inside a window the owner grants"},"openWindow":{"$ref":"#/components/schemas/AccountOpenWindow"}},"required":["mode","openWindow"],"additionalProperties":false},"AccountSupportAccessSettingsGetV2Response":{"type":"object","properties":{"mode":{"type":"string","enum":["allowed","notify","approval"],"description":"Governs only Point11 support viewing the app as one of your members. allowed: support may start such a view and no one is emailed; notify: the owners are emailed each time support starts one; approval: support may start one only inside a window the owner grants"},"openWindow":{"$ref":"#/components/schemas/AccountOpenWindow"}},"required":["mode","openWindow"],"additionalProperties":false},"AccountSsoDomainsListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The domain's id."},"domain":{"type":"string","description":"The email domain, such as `acme.com`."},"state":{"type":"string","enum":["pending","verified","failed"],"description":"`pending` until its DNS record is found, then `verified`; `failed` when it was not found within 30 days, which a check starts again."},"record":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","const":"TXT"},"name":{"type":"string","description":"The record's name: the domain itself."},"value":{"type":"string","description":"The record's value, exactly as given."}},"required":["type","name","value"],"additionalProperties":false},{"type":"null"}],"description":"The DNS record that proves the organization owns the domain, while it is not verified; null once it is."}},"required":["id","domain","state","record"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"AccountSsoSettingsGetResponse":{"type":"object","properties":{"connection":{"type":"string","enum":["none","inactive","active"],"description":"The identity provider connection: none, set up but not signing anyone in yet, or active. While it is active, its verified domains sign in through it."},"directory":{"type":"string","enum":["none","inactive","active"],"description":"The connected directory, in the same states."},"domains":{"readOnly":true,"description":"The verified email domains single sign-on governs.","type":"array","items":{"type":"string"}},"enforceSso":{"type":"boolean","description":"Whether those domains sign in only through the identity provider, whatever WorkOS's own settings say."},"setupAvailable":{"type":"boolean","description":"Whether single sign-on can be set up: it needs an active paid subscription."}},"required":["connection","directory","domains","enforceSso","setupAvailable"],"additionalProperties":false},"AccountConnectedAppsListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"clientId":{"type":"string","description":"The app's OAuth client id: its Client ID Metadata Document URL, or the id it was registered under"},"name":{"type":"string","description":"The app as Settings names it: its client id URL's host, else its id"},"level":{"type":"string","enum":["read_only","full","blocked"],"description":"read_only: the app may only read; full: it may do what the member's role and the organization's policy allow; blocked: every call it makes is refused"},"firstSeenAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"When the app first acted for the member here"},"lastSeenAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"When the app last acted for the member here, to the minute"}},"required":["id","clientId","name","level","firstSeenAt","lastSeenAt"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"AccountAiClientPoliciesGetResponse":{"type":"object","properties":{"policy":{"type":"string","enum":["allowed","read_only","off"],"description":"allowed: AI clients may act as each member's role and own level for them allow; read_only: they may only read; off: every call they make is refused. API keys are not affected"}},"required":["policy"],"additionalProperties":false},"CampaignsActivitiesGetV3Response":{"type":"object","properties":{"scope":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"campaign"},"product":{"type":"string","enum":["discovery","research","experience"]},"campaignId":{"type":"string"}},"required":["kind","product","campaignId"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"product"},"product":{"type":"string","enum":["discovery","research","experience"]}},"required":["kind","product"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"organization"}},"required":["kind"],"additionalProperties":false}]},"observedAt":{"type":"string","description":"ISO timestamp the activity was observed at."},"through":{"type":"string","description":"ISO end of the window the plan reads through."},"timeZone":{"type":"string","description":"IANA zone the scope's work runs on."},"nextCustomer":{"anyOf":[{"type":"object","properties":{"product":{"type":"string","enum":["discovery","research","experience"]},"campaignId":{"type":"string"},"campaignName":{"type":"string"},"at":{"type":"string","description":"ISO timestamp."}},"required":["product","campaignId","campaignName","at"],"additionalProperties":false},{"type":"null"}]},"nextRun":{"anyOf":[{"type":"object","properties":{"product":{"type":"string","enum":["discovery","research","experience"]},"campaignId":{"type":"string"},"campaignName":{"type":"string"},"at":{"type":"string","description":"ISO timestamp."}},"required":["product","campaignId","campaignName","at"],"additionalProperties":false},{"type":"null"}]},"execution":{"type":"object","properties":{"running":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Customer work executing now: for a product or the organization, every run Billing admitted for a campaign entry and has not finished, started or not."},"queued":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Customer work admitted and due now that has not started: one campaign's alone, which a product or the organization counts as running."},"due":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Customer work placed and past its time but not yet admitted (for a product or the organization, each campaign's stored next customer once its time has passed), a one-time or repeating campaign's admission whose time has passed, and an always-on Experience cycle's opening until that cycle is planned."},"finishing":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Of `running` and `queued`, the work of campaigns whose lifecycle is paused or archived (a person's pause or archive): earlier work finishing. Such a campaign starts nothing new; what it already admitted finishes, or is released at its product's start check. A subscription pause, a hold or a billing refusal leaves a campaign's lifecycle Active, so its work in flight reads Running. When `finishing` is all of the scope's work in flight, the scope is finishing earlier work rather than Running."}},"required":["running","queued","due","finishing"],"additionalProperties":false,"description":"Customer work in flight, summed over every campaign in scope: one campaign's from its product's calendar (conversations, visits or interviews, never launches), a product's or the organization's from stored facts (the runs Billing admitted and has not finished, and each campaign's stored next customer once its time has passed). Any of it means the scope is Running, unless `finishing` is all of it."},"state":{"type":"string","enum":["ready","paused","no_campaigns","unavailable"]},"pause":{"anyOf":[{"type":"object","properties":{"cause":{"type":"string","enum":["user","subscription","billing","schedule","setup","refused","nothing_scheduled","hold"]},"detail":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["cause","detail"],"additionalProperties":false},{"type":"null"}],"description":"Why nothing is coming; present exactly when state is \"paused\"."},"admissions":{"type":"object","properties":{"discovery":{"type":"object","properties":{"allowed":{"type":"boolean","description":"Whether the account admits new work for this product now."},"unavailable":{"type":"boolean","description":"The check could not be made; it refuses nothing on the account's behalf."},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Billing's or Identity's sentence for a refusal or an unavailable check."},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Billing's refusal code when Billing refuses new work, account-wide or this period's usage, else null."},"subscriptionPaused":{"type":"boolean","description":"The organization's Analytics subscription is paused."},"paymentDisputeHold":{"description":"A payment dispute holds the account; its one action is support.","type":"boolean","const":true}},"required":["allowed","unavailable","reason","code","subscriptionPaused"],"additionalProperties":false},"experience":{"type":"object","properties":{"allowed":{"type":"boolean","description":"Whether the account admits new work for this product now."},"unavailable":{"type":"boolean","description":"The check could not be made; it refuses nothing on the account's behalf."},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Billing's or Identity's sentence for a refusal or an unavailable check."},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Billing's refusal code when Billing refuses new work, account-wide or this period's usage, else null."},"subscriptionPaused":{"type":"boolean","description":"The organization's Analytics subscription is paused."},"paymentDisputeHold":{"description":"A payment dispute holds the account; its one action is support.","type":"boolean","const":true}},"required":["allowed","unavailable","reason","code","subscriptionPaused"],"additionalProperties":false},"research":{"type":"object","properties":{"allowed":{"type":"boolean","description":"Whether the account admits new work for this product now."},"unavailable":{"type":"boolean","description":"The check could not be made; it refuses nothing on the account's behalf."},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Billing's or Identity's sentence for a refusal or an unavailable check."},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Billing's refusal code when Billing refuses new work, account-wide or this period's usage, else null."},"subscriptionPaused":{"type":"boolean","description":"The organization's Analytics subscription is paused."},"paymentDisputeHold":{"description":"A payment dispute holds the account; its one action is support.","type":"boolean","const":true}},"required":["allowed","unavailable","reason","code","subscriptionPaused"],"additionalProperties":false}},"additionalProperties":false,"description":"The account's admission of new work for each product the scope covers."},"revision":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The organization's activity revision; null when it could not be read."}},"required":["scope","observedAt","through","timeZone","nextCustomer","nextRun","execution","state","pause","admissions","revision"],"additionalProperties":false},"CampaignsActivityRevisionsGetResponse":{"type":"object","properties":{"revision":{"type":"string","description":"Opaque; changes whenever campaign work, admission, or the organization's runs change: a run admitted or settled, never a running run's progress."},"progress":{"type":"string","description":"Opaque; changes while the organization's runs are running, with each write one of them takes (its progress included)."},"work":{"type":"string","description":"Opaque; changes only with campaign work: a campaign write, an entry opening or settling, an Experience visit settling, or results publishing. A run's admission alone never changes it (an Experience visit admitted inside its cycle's open entry included), nor does a running run's progress. Compare it to decide whether to read campaign results again."},"products":{"type":"object","properties":{"discovery":{"type":"string"},"experience":{"type":"string"},"research":{"type":"string"}},"required":["discovery","experience","research"],"additionalProperties":false,"description":"Opaque, one per campaign product; each changes only with that product's own campaigns: a campaign write, an entry opening or settling, its results publishing (each Research interview delivering or failing included), or a change in what admission refuses the product. Another product's work or runs never change it, nor does a run's admission alone. Compare the product a page shows to decide whether to read its results again."}},"required":["revision","progress","work","products"],"additionalProperties":false},"CampaignsPortfoliosGetResponse":{"type":"object","properties":{"products":{"type":"object","properties":{"discovery":{"type":"boolean"},"experience":{"type":"boolean"},"research":{"type":"boolean"}},"required":["discovery","experience","research"],"additionalProperties":false,"description":"Which products the organization has run."},"campaigns":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"product":{"type":"string","enum":["discovery","research","experience"]},"targetKind":{"anyOf":[{"type":"string","enum":["profile","physical_locations"]},{"type":"null"}],"description":"What a Discovery campaign measures; null for any other campaign."},"forecastAudience":{"type":"boolean","description":"Whether a Discovery campaign's customers are its forecast's alone (forecast mode, as Bootup's Forecast campaign); false for any other campaign."},"businessProfileId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The business profile the campaign is linked to; null for a Discovery or Research campaign not linked to one."}},"required":["id","name","product","targetKind","forecastAudience","businessProfileId"],"additionalProperties":false},"description":"Every campaign the list shows, in name order."},"current":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"product":{"type":"string","enum":["discovery","research","experience"]}},"required":["id","product"],"additionalProperties":false},{"type":"null"}],"description":"The preferred campaign while it is listed, else the newest listed."},"openable":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","description":"\"Discovery\" or the Research playbook's label."}},"required":["id","type"],"additionalProperties":false},{"type":"null"}],"description":"The campaign that opens as current: the preferred one while it has results to show, else the newest that does."}},"required":["products","campaigns","current","openable"],"additionalProperties":false},"CampaignsSummariesListV2Response":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/CampaignsDataItem"}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"totalCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Campaigns matching the product and status filters."},"hasCampaigns":{"type":"boolean","description":"Whether the organization has any listed campaign of this product at all."}},"required":["data","nextCursor","totalCount","hasCampaigns"],"additionalProperties":false},"CampaignsSummariesGetV2Response":{"type":"object","properties":{"campaign":{"$ref":"#/components/schemas/CampaignsDataItem"},"supportOwned":{"type":"boolean","description":"Point11 support owns the campaign's failed work: an open delivery issue is recorded for it."}},"required":["campaign","supportOwned"],"additionalProperties":false},"CampaignsCampaignRoutesGetResponse":{"type":"object","properties":{"id":{"type":"string"},"campaignKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"product":{"type":"string","enum":["discovery","research","experience"]},"name":{"type":"string"},"status":{"type":"string","enum":["active","paused","archived","deleted"]},"settings":{"anyOf":[{"type":"object","properties":{"url":{"type":"string"},"domain":{"type":"string"},"schedule":{"$ref":"#/components/schemas/CampaignsSchedule"},"work":{"$ref":"#/components/schemas/CampaignsWork"},"readiness":{"type":"object","properties":{"state":{"type":"string","enum":["ready","preparing","needs_attention"]},"message":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["state","message"],"additionalProperties":false}},"required":["url","domain","schedule","work","readiness"],"additionalProperties":false,"description":"Its website, schedule, work and setup readiness, as campaigns.summaries.get.v2 states them: whether it takes a change and where its page opens. Null unless `settings` is true."},{"type":"null"}]}},"required":["id","campaignKey","product","name","status","settings"],"additionalProperties":false},"CampaignsCampaignSelectionsListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"product":{"type":"string","enum":["discovery","research","experience"]},"status":{"type":"string","enum":["active","paused","archived","deleted"]},"schedule":{"type":"object","properties":{"mode":{"type":"string","enum":["calendar","once","recurring","source","unavailable"]},"nextAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO timestamp of a one-time campaign's next run; null once it has none, and for every other schedule."}},"required":["mode","nextAt"],"additionalProperties":false},"work":{"type":"object","properties":{"state":{"type":"string","enum":["not_started","in_progress","settled","unknown"]}},"required":["state"],"additionalProperties":false}},"required":["id","product","status","schedule","work"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"totalCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Campaigns matching the product and status filters, every page together."}},"required":["data","nextCursor","totalCount"],"additionalProperties":false},"CampaignsCampaignEntriesListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/CampaignsDataItem2"}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"CampaignsCampaignEntriesGetResponse":{"type":"object","properties":{"entry":{"$ref":"#/components/schemas/CampaignsDataItem2"},"units":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"state":{"type":"string","enum":["open","delivered","failed"]},"failureReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"startedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO timestamp."},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO timestamp."}},"required":["id","state","failureReason","startedAt","completedAt"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false,"description":"A page of the entry's units, earliest started first."}},"required":["entry","units"],"additionalProperties":false},"CampaignsCampaignEntriesListV2Response":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/CampaignsDataItem3"}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"CampaignsCampaignEntriesGetV2Response":{"type":"object","properties":{"entry":{"$ref":"#/components/schemas/CampaignsDataItem3"},"units":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"state":{"type":"string","enum":["open","delivered","failed"]},"failureReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"startedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO timestamp."},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO timestamp."}},"required":["id","state","failureReason","startedAt","completedAt"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false,"description":"A page of the entry's units, earliest started first."}},"required":["entry","units"],"additionalProperties":false},"CampaignsMemberRerunsListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"campaignId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"product":{"type":"string","enum":["discovery","research","experience"]},"customerId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"customerVersionId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The customer's version the edit wrote; the rerun runs on it or a newer one."},"requestId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The edit's rerun request."},"requestedAt":{"type":"string","description":"ISO timestamp."},"state":{"type":"string","enum":["waiting","started","ended"],"description":"`waiting` until its product starts it (it ends as `expired` after 24 hours waiting), `started` once it runs in its campaign entry, `ended` when it ended without running."},"entryId":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},{"type":"null"}],"description":"The campaign entry (origin `edit_rerun`) it runs in, once started; read its progress with campaigns.campaign-entries.get.v2."},"entryStatus":{"anyOf":[{"type":"string","enum":["running","succeeded","failed","cancelled","partial"]},{"type":"null"}],"description":"That entry's status, once started: running until it settles."},"endedReason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Why it ended without running, a code: `expired`, `campaign_paused`, `campaign_archived`, `removed`, `scrubbed`, `coverage_unavailable`, or Billing's refusal reason."}},"required":["id","campaignId","product","customerId","customerVersionId","requestId","requestedAt","state","entryId","entryStatus","endedReason"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"CampaignsLifecyclesPauseRequest":{"type":"object","properties":{"targets":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The campaign's id."},"product":{"type":"string","enum":["discovery","research","experience"],"description":"The product that owns the campaign."}},"required":["id","product"],"additionalProperties":false},"description":"Campaigns to change, at most 100; a campaign named twice is changed once."}},"required":["targets"],"additionalProperties":false},"CampaignsLifecyclesPauseResponse":{"type":"object","properties":{"requestedCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct campaigns the command named."},"changedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"unchangedCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Campaigns already in the requested state."},"blockedCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Campaigns the command cannot change from their current state."},"pendingCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Campaigns whose deletion waits for running work to stop; it completes without another call."},"missingCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Named campaigns that are not that product's in the organization's Campaigns list."},"targetResults":{"$ref":"#/components/schemas/CampaignsTargetResults"}},"required":["requestedCount","changedCount","unchangedCount","blockedCount","pendingCount","missingCount","targetResults"],"additionalProperties":false},"CampaignsLifecyclesResumeRequest":{"type":"object","properties":{"targets":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The campaign's id."},"product":{"type":"string","enum":["discovery","research","experience"],"description":"The product that owns the campaign."}},"required":["id","product"],"additionalProperties":false},"description":"Campaigns to change, at most 100; a campaign named twice is changed once."}},"required":["targets"],"additionalProperties":false},"CampaignsLifecyclesResumeResponse":{"type":"object","properties":{"requestedCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct campaigns the command named."},"changedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"unchangedCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Campaigns already in the requested state."},"blockedCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Campaigns the command cannot change from their current state."},"pendingCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Campaigns whose deletion waits for running work to stop; it completes without another call."},"missingCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Named campaigns that are not that product's in the organization's Campaigns list."},"targetResults":{"$ref":"#/components/schemas/CampaignsTargetResults"}},"required":["requestedCount","changedCount","unchangedCount","blockedCount","pendingCount","missingCount","targetResults"],"additionalProperties":false},"CampaignsLifecyclesArchiveRequest":{"type":"object","properties":{"targets":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The campaign's id."},"product":{"type":"string","enum":["discovery","research","experience"],"description":"The product that owns the campaign."}},"required":["id","product"],"additionalProperties":false},"description":"Campaigns to change, at most 100; a campaign named twice is changed once."}},"required":["targets"],"additionalProperties":false},"CampaignsLifecyclesArchiveResponse":{"type":"object","properties":{"requestedCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct campaigns the command named."},"changedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"unchangedCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Campaigns already in the requested state."},"blockedCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Campaigns the command cannot change from their current state."},"pendingCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Campaigns whose deletion waits for running work to stop; it completes without another call."},"missingCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Named campaigns that are not that product's in the organization's Campaigns list."},"targetResults":{"$ref":"#/components/schemas/CampaignsTargetResults"}},"required":["requestedCount","changedCount","unchangedCount","blockedCount","pendingCount","missingCount","targetResults"],"additionalProperties":false},"CampaignsLifecyclesRestoreRequest":{"type":"object","properties":{"targets":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The campaign's id."},"product":{"type":"string","enum":["discovery","research","experience"],"description":"The product that owns the campaign."}},"required":["id","product"],"additionalProperties":false},"description":"Campaigns to change, at most 100; a campaign named twice is changed once."}},"required":["targets"],"additionalProperties":false},"CampaignsLifecyclesRestoreResponse":{"type":"object","properties":{"requestedCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct campaigns the command named."},"changedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"unchangedCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Campaigns already in the requested state."},"blockedCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Campaigns the command cannot change from their current state."},"pendingCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Campaigns whose deletion waits for running work to stop; it completes without another call."},"missingCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Named campaigns that are not that product's in the organization's Campaigns list."},"targetResults":{"$ref":"#/components/schemas/CampaignsTargetResults"}},"required":["requestedCount","changedCount","unchangedCount","blockedCount","pendingCount","missingCount","targetResults"],"additionalProperties":false},"CampaignsLifecyclesDeleteRequest":{"type":"object","properties":{"targets":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The campaign's id."},"product":{"type":"string","enum":["discovery","research","experience"],"description":"The product that owns the campaign."}},"required":["id","product"],"additionalProperties":false},"description":"Campaigns to change, at most 100; a campaign named twice is changed once."}},"required":["targets"],"additionalProperties":false},"CampaignsLifecyclesDeleteResponse":{"type":"object","properties":{"requestedCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct campaigns the command named."},"changedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"unchangedCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Campaigns already in the requested state."},"blockedCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Campaigns the command cannot change from their current state."},"pendingCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Campaigns whose deletion waits for running work to stop; it completes without another call."},"missingCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Named campaigns that are not that product's in the organization's Campaigns list."},"targetResults":{"$ref":"#/components/schemas/CampaignsTargetResults"}},"required":["requestedCount","changedCount","unchangedCount","blockedCount","pendingCount","missingCount","targetResults"],"additionalProperties":false},"CampaignsCalendarsGetResponse":{"type":"object","properties":{"campaigns":{"readOnly":true,"type":"array","items":{"type":"object","properties":{"campaignType":{"type":"string","enum":["discovery","research","experience"]},"campaignId":{"type":"string"},"name":{"type":"string"},"paused":{"type":"boolean","description":"Paused by its owner, or Active under a paused subscription."},"ordinal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Its place among every listed campaign, filtered or not; fixes its ink."},"profileId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The business profile it plans by."}},"required":["campaignType","campaignId","name","paused","ordinal","profileId"],"additionalProperties":false}},"publications":{"readOnly":true,"type":"array","items":{"type":"object","properties":{"campaignId":{"type":"string"},"campaignType":{"type":"string","enum":["discovery","research","experience"]},"campaignName":{"type":"string"},"campaignStatus":{"type":"string"},"kind":{"type":"string","enum":["planned","journeys","research"]},"timeZone":{"type":"string","description":"The zone this month is drawn in."},"defaultTimeZone":{"type":"string","description":"The campaign's own zone."},"cycle":{"type":"string","description":"`YYYY-MM`: the UTC month."},"nextAdmissionAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"engines":{"readOnly":true,"type":"array","items":{"type":"string"}},"lines":{"readOnly":true,"type":"array","items":{"type":"object","properties":{"lineId":{"type":"string"},"name":{"type":"string"},"counted":{"description":"False for a line that keeps its own counts but adds to no total.","type":"boolean","const":false},"entryCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"targetCountsByInterval":{"readOnly":true,"type":"array","items":{"type":"object","properties":{"startsAt":{"type":"string"},"endsAt":{"type":"string"},"date":{"type":"string"},"hour":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"entryCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"lifecycleCounts":{"type":"object","properties":{"scheduled":{"type":"integer","minimum":0,"maximum":9007199254740991},"committed":{"type":"integer","minimum":0,"maximum":9007199254740991},"running":{"type":"integer","minimum":0,"maximum":9007199254740991},"finished":{"type":"integer","minimum":0,"maximum":9007199254740991},"cancelled":{"type":"integer","minimum":0,"maximum":9007199254740991},"unknown":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["scheduled","committed","running","finished","cancelled","unknown"],"additionalProperties":false},"pauseHeldCount":{"description":"How many of the hour's interactions a pause holds, whatever their campaign's status: drawn paused while their campaign is paused, by itself or its subscription. Absent for none.","type":"integer","minimum":0,"maximum":9007199254740991},"hiddenCount":{"description":"How many interactions of paused activity `showPaused: false` left out of the hour, counted in no other total. Absent for none.","type":"integer","minimum":0,"maximum":9007199254740991}},"required":["startsAt","endsAt","date","hour","entryCount","lifecycleCounts"],"additionalProperties":false}}},"required":["lineId","name","entryCount","targetCountsByInterval"],"additionalProperties":false}},"targetCountsByInterval":{"readOnly":true,"type":"array","items":{"type":"object","properties":{"startsAt":{"type":"string"},"endsAt":{"type":"string"},"date":{"type":"string"},"hour":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"entryCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"lifecycleCounts":{"type":"object","properties":{"scheduled":{"type":"integer","minimum":0,"maximum":9007199254740991},"committed":{"type":"integer","minimum":0,"maximum":9007199254740991},"running":{"type":"integer","minimum":0,"maximum":9007199254740991},"finished":{"type":"integer","minimum":0,"maximum":9007199254740991},"cancelled":{"type":"integer","minimum":0,"maximum":9007199254740991},"unknown":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["scheduled","committed","running","finished","cancelled","unknown"],"additionalProperties":false},"pauseHeldCount":{"description":"How many of the hour's interactions a pause holds, whatever their campaign's status: drawn paused while their campaign is paused, by itself or its subscription. Absent for none.","type":"integer","minimum":0,"maximum":9007199254740991},"hiddenCount":{"description":"How many interactions of paused activity `showPaused: false` left out of the hour, counted in no other total. Absent for none.","type":"integer","minimum":0,"maximum":9007199254740991},"entries":{"$ref":"#/components/schemas/CampaignsEntries"}},"required":["startsAt","endsAt","date","hour","entryCount","lifecycleCounts","entries"],"additionalProperties":false}},"expandedWindow":{"anyOf":[{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"},"entryCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"entries":{"$ref":"#/components/schemas/CampaignsEntries"},"lifecycleCounts":{"type":"object","properties":{"scheduled":{"type":"integer","minimum":0,"maximum":9007199254740991},"committed":{"type":"integer","minimum":0,"maximum":9007199254740991},"running":{"type":"integer","minimum":0,"maximum":9007199254740991},"finished":{"type":"integer","minimum":0,"maximum":9007199254740991},"cancelled":{"type":"integer","minimum":0,"maximum":9007199254740991},"unknown":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["scheduled","committed","running","finished","cancelled","unknown"],"additionalProperties":false}},"required":["from","to","entryCount","entries","lifecycleCounts"],"additionalProperties":false},{"type":"null"}]},"capabilities":{"description":"Whether this month accepts an interaction created from the calendar.","type":"object","properties":{"create":{"type":"boolean"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["create","reason"],"additionalProperties":false},"awaitingPlacement":{"description":"The first span of this month whose customers no run has placed yet: a Discovery month, which its first daily slice writes, or a Research quota period, which an admission day plans a period ahead. The calendar draws stored placement alone, so until then the span shows only what ran. Absent where every span is placed or closed, or the campaign promises no admission (`nextAdmissionAt` null).","type":"object","properties":{"from":{"type":"string","description":"`YYYY-MM-DD`: the span's first UTC day."},"to":{"type":"string","description":"`YYYY-MM-DD`: the UTC day after its last."},"placesOn":{"type":"string","description":"`YYYY-MM-DD`: the UTC day the campaign's admission places its customers."}},"required":["from","to","placesOn"],"additionalProperties":false}},"required":["campaignId","campaignType","campaignStatus","kind","timeZone","defaultTimeZone","cycle","nextAdmissionAt","engines","lines","targetCountsByInterval","expandedWindow"],"additionalProperties":false}},"truncated":{"type":"boolean","description":"More campaigns are listed than this page draws."},"campaignPage":{"type":"object","properties":{"total":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The campaigns the filters list, besides the ones switched off, on every page."},"start":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"How many of them come before this page's first."},"previousCursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The `cursor` of the page before this one; null on the first page, and on the second, whose page is read with no cursor."},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The `cursor` of the next page; null on the last."}},"required":["total","start","previousCursor","nextCursor"],"additionalProperties":false,"description":"Where this page of at most 50 drawn campaigns stands: by product then name, the campaigns holding `customerId` first."},"failed":{"readOnly":true,"type":"array","items":{"type":"object","properties":{"campaignId":{"type":"string"},"campaignType":{"type":"string","enum":["discovery","research","experience"]}},"required":["campaignId","campaignType"],"additionalProperties":false}},"subscriptionPaused":{"type":"boolean"},"admissionRefusals":{"type":"object","additionalProperties":false,"required":["discovery","research","experience"],"description":"Per product, Billing's or Identity's sentence when the account admits none of its new work now, which an interaction scheduled now waits on; null when it admits new work, or when the check could not be made, which refuses nothing.","properties":{"discovery":{"anyOf":[{"type":"string"},{"type":"null"}]},"research":{"anyOf":[{"type":"string"},{"type":"null"}]},"experience":{"anyOf":[{"type":"string"},{"type":"null"}]}}},"customerEntries":{"readOnly":true,"description":"Every interaction of `customerId` in the grid's months, at most 500 per campaign, the ones nearest `anchor`; empty without one.","type":"array","items":{"$ref":"#/components/schemas/CampaignsCustomerEntriesItem"}},"customerEntriesTruncated":{"type":"boolean","description":"A campaign holds more interactions of `customerId` than `customerEntries` names."},"focus":{"anyOf":[{"oneOf":[{"type":"object","properties":{"state":{"type":"string","const":"published"}},"required":["state"],"additionalProperties":false},{"type":"object","properties":{"state":{"type":"string","const":"read"},"entry":{"anyOf":[{"type":"object","properties":{"lifecycle":{"type":"string","enum":["scheduled","committed","running","finished","cancelled","unknown"]},"waitingReason":{"description":"Why scheduled work is not admitted yet, when known.","anyOf":[{"type":"string"},{"type":"null"}]},"scheduledAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"admittedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"startedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"finishedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"executionId":{"anyOf":[{"type":"string"},{"type":"null"}]},"outcome":{"anyOf":[{"type":"string","enum":["running","succeeded","failed","cancelled","partial"]},{"type":"null"}]},"rerun":{"description":"Present on an edit's rerun: a customer whose edit gave it a new version, rerun once on it as its run of the campaign's current period. It is its own entry and never moves.","type":"boolean","const":true},"inClosedHour":{"description":"Present on a scheduled interaction a person or an order placed in an hour the calendar rules now close. It stays where it was placed.","type":"boolean","const":true},"missed":{"description":"Present on an interaction whose period (its month, or a Research interview's quota period) closed with no run admitting it. Its lifecycle stays `scheduled`, it stays on its day, and it no longer moves.","type":"boolean","const":true},"movedFrom":{"description":"Present when the plan moved the interaction since placing it; absent when a person placed it.","type":"object","properties":{"at":{"type":"string","description":"Where the plan first placed the interaction."},"reason":{"type":"string","enum":["catch_up","rules_save"],"description":"Why the plan moved it: `catch_up`, its slot passed unrun; `rules_save`, the calendar rules changed."}},"required":["at","reason"],"additionalProperties":false},"capabilities":{"type":"object","properties":{"move":{"type":"boolean"},"cancel":{"type":"boolean"},"restore":{"type":"boolean"},"reasonCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"moveMonth":{"description":"`YYYY-MM`: the UTC month a move must stay inside, where one bounds it.","type":"string"},"moveBounds":{"description":"`[from, to)`: the instants a move must land between, beside `moveMonth`, where the interaction has a schedule to move. A move outside them is refused.","type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"}},"required":["from","to"],"additionalProperties":false}},"required":["move","cancel","restore","reasonCode","reason"],"additionalProperties":false},"entryId":{"type":"string"},"lineId":{"type":"string"},"name":{"type":"string"},"targetAt":{"type":"string"},"kind":{"type":"string","const":"customer"},"customerId":{"type":"string"},"customerKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"jobTitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"age":{"anyOf":[{"type":"string"},{"type":"null"}]},"avatarUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"campaign":{"type":"object","properties":{"type":{"type":"string","enum":["discovery","research","experience"]},"id":{"type":"string"}},"required":["type","id"],"additionalProperties":false},"paused":{"description":"Paused activity: the campaign's own pause (status Paused) holds this interaction, which will not start while it stays paused, and `showPaused: false` leaves it out of the calendar. A paused subscription marks none, unlike `campaigns[].paused`, which also reads an Active campaign under a paused subscription as paused. Absent otherwise.","type":"boolean","const":true}},"required":["lifecycle","scheduledAt","admittedAt","startedAt","finishedAt","executionId","outcome","capabilities","entryId","lineId","name","targetAt","customerId","customerKey","jobTitle","age","avatarUrl","campaign"],"additionalProperties":false},{"type":"object","properties":{"lifecycle":{"type":"string","enum":["scheduled","committed","running","finished","cancelled","unknown"]},"waitingReason":{"description":"Why scheduled work is not admitted yet, when known.","anyOf":[{"type":"string"},{"type":"null"}]},"scheduledAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"admittedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"startedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"finishedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"executionId":{"anyOf":[{"type":"string"},{"type":"null"}]},"outcome":{"anyOf":[{"type":"string","enum":["running","succeeded","failed","cancelled","partial"]},{"type":"null"}]},"rerun":{"description":"Present on an edit's rerun: a customer whose edit gave it a new version, rerun once on it as its run of the campaign's current period. It is its own entry and never moves.","type":"boolean","const":true},"inClosedHour":{"description":"Present on a scheduled interaction a person or an order placed in an hour the calendar rules now close. It stays where it was placed.","type":"boolean","const":true},"missed":{"description":"Present on an interaction whose period (its month, or a Research interview's quota period) closed with no run admitting it. Its lifecycle stays `scheduled`, it stays on its day, and it no longer moves.","type":"boolean","const":true},"movedFrom":{"description":"Present when the plan moved the interaction since placing it; absent when a person placed it.","type":"object","properties":{"at":{"type":"string","description":"Where the plan first placed the interaction."},"reason":{"type":"string","enum":["catch_up","rules_save"],"description":"Why the plan moved it: `catch_up`, its slot passed unrun; `rules_save`, the calendar rules changed."}},"required":["at","reason"],"additionalProperties":false},"capabilities":{"type":"object","properties":{"move":{"type":"boolean"},"cancel":{"type":"boolean"},"restore":{"type":"boolean"},"reasonCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"moveMonth":{"description":"`YYYY-MM`: the UTC month a move must stay inside, where one bounds it.","type":"string"},"moveBounds":{"description":"`[from, to)`: the instants a move must land between, beside `moveMonth`, where the interaction has a schedule to move. A move outside them is refused.","type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"}},"required":["from","to"],"additionalProperties":false}},"required":["move","cancel","restore","reasonCode","reason"],"additionalProperties":false},"entryId":{"type":"string"},"lineId":{"type":"string"},"name":{"type":"string"},"targetAt":{"type":"string"},"kind":{"type":"string","const":"research-run"},"interviewCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"completedInterviewCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"resultsHref":{"anyOf":[{"type":"string"},{"type":"null"}]},"campaign":{"type":"object","properties":{"type":{"type":"string","enum":["discovery","research","experience"]},"id":{"type":"string"}},"required":["type","id"],"additionalProperties":false},"paused":{"description":"Paused activity: the campaign's own pause (status Paused) holds this interaction, which will not start while it stays paused, and `showPaused: false` leaves it out of the calendar. A paused subscription marks none, unlike `campaigns[].paused`, which also reads an Active campaign under a paused subscription as paused. Absent otherwise.","type":"boolean","const":true}},"required":["lifecycle","scheduledAt","admittedAt","startedAt","finishedAt","executionId","outcome","capabilities","entryId","lineId","name","targetAt","kind","interviewCount","completedInterviewCount","resultsHref","campaign"],"additionalProperties":false}]}},"required":["state","entry"],"additionalProperties":false},{"type":"object","properties":{"state":{"type":"string","const":"gone"}},"required":["state"],"additionalProperties":false},{"type":"object","properties":{"state":{"type":"string","const":"failed"}},"required":["state"],"additionalProperties":false}]},{"type":"null"}],"description":"The asked entry (`entryCampaignId`, `entryId`): already named by the months or the customer's interactions, read by id, gone from the calendar, or unreadable; null when none was asked, its campaign is not shown, or `only` is set."}},"required":["campaigns","publications","truncated","campaignPage","failed","subscriptionPaused","admissionRefusals","customerEntries","customerEntriesTruncated","focus"],"additionalProperties":false},"CampaignsCalendarsSearchResponse":{"type":"object","properties":{"hits":{"readOnly":true,"description":"A date first, then campaigns, then customers, then interactions in time order.","type":"array","items":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"date"},"view":{"anyOf":[{"type":"string","enum":["day","week","month","agenda"]},{"type":"null"}]},"anchor":{"type":"string"},"label":{"type":"string"}},"required":["kind","view","anchor","label"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"campaign"},"campaign":{"type":"object","properties":{"type":{"type":"string","enum":["discovery","research","experience"]},"id":{"type":"string"},"name":{"type":"string"}},"required":["type","id","name"],"additionalProperties":false}},"required":["kind","campaign"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"customer"},"customerId":{"type":"string"},"name":{"type":"string"},"entryCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["kind","customerId","name","entryCount"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"entry"},"entry":{"$ref":"#/components/schemas/CampaignsCustomerEntriesItem"}},"required":["kind","entry"],"additionalProperties":false}]}},"horizon":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"}},"required":["from","to"],"additionalProperties":false,"description":"The first and last `YYYY-MM` searched."},"truncated":{"type":"boolean","description":"More campaigns, customers or interactions matched than are returned: more words narrow it."},"failed":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["hits","horizon","truncated","failed"],"additionalProperties":false},"CampaignsCalendarFilterOptionsGetResponse":{"type":"object","properties":{"products":{"readOnly":true,"type":"array","items":{"type":"string","enum":["discovery","research","experience"]}},"profiles":{"readOnly":true,"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"campaigns":{"readOnly":true,"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["discovery","research","experience"]},"profileId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","type","profileId"],"additionalProperties":false}}},"required":["products","profiles","campaigns"],"additionalProperties":false},"CampaignsCalendarWindowsSearchResponse":{"type":"object","properties":{"campaigns":{"readOnly":true,"description":"Each campaign that answered, in the calendar's order.","type":"array","items":{"type":"object","properties":{"campaignType":{"type":"string","enum":["discovery","research","experience"]},"campaignId":{"type":"string"},"entryCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"lifecycleCounts":{"type":"object","properties":{"scheduled":{"type":"integer","minimum":0,"maximum":9007199254740991},"committed":{"type":"integer","minimum":0,"maximum":9007199254740991},"running":{"type":"integer","minimum":0,"maximum":9007199254740991},"finished":{"type":"integer","minimum":0,"maximum":9007199254740991},"cancelled":{"type":"integer","minimum":0,"maximum":9007199254740991},"unknown":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["scheduled","committed","running","finished","cancelled","unknown"],"additionalProperties":false},"entries":{"$ref":"#/components/schemas/CampaignsEntries"}},"required":["campaignType","campaignId","entryCount","lifecycleCounts","entries"],"additionalProperties":false}},"failed":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Campaigns whose read failed; the others still answered."}},"required":["campaigns","failed"],"additionalProperties":false},"CampaignsCalendarOccurrencesGetResponse":{"type":"object","properties":{"occurrence":{"type":"object","properties":{"campaignType":{"type":"string","enum":["discovery","research","experience"]},"campaignId":{"type":"string"},"occurrenceId":{"type":"string"},"lifecycle":{"type":"string","enum":["scheduled","committed","running","finished","cancelled","unknown"]},"waitingReason":{"description":"Why scheduled work is not admitted yet, when known.","anyOf":[{"type":"string"},{"type":"null"}]},"scheduledAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"admittedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"startedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"finishedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"executionId":{"anyOf":[{"type":"string"},{"type":"null"}]},"outcome":{"anyOf":[{"type":"string","enum":["running","succeeded","failed","cancelled","partial"]},{"type":"null"}]},"rerun":{"description":"Present on an edit's rerun: a customer whose edit gave it a new version, rerun once on it as its run of the campaign's current period. It is its own entry and never moves.","type":"boolean","const":true},"inClosedHour":{"description":"Present on a scheduled interaction a person or an order placed in an hour the calendar rules now close. It stays where it was placed.","type":"boolean","const":true},"missed":{"description":"Present on an interaction whose period (its month, or a Research interview's quota period) closed with no run admitting it. Its lifecycle stays `scheduled`, it stays on its day, and it no longer moves.","type":"boolean","const":true},"movedFrom":{"description":"Present when the plan moved the interaction since placing it; absent when a person placed it.","type":"object","properties":{"at":{"type":"string","description":"Where the plan first placed the interaction."},"reason":{"type":"string","enum":["catch_up","rules_save"],"description":"Why the plan moved it: `catch_up`, its slot passed unrun; `rules_save`, the calendar rules changed."}},"required":["at","reason"],"additionalProperties":false},"capabilities":{"type":"object","properties":{"move":{"type":"boolean"},"cancel":{"type":"boolean"},"restore":{"type":"boolean"},"reasonCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"moveMonth":{"description":"`YYYY-MM`: the UTC month a move must stay inside, where one bounds it.","type":"string"},"moveBounds":{"description":"`[from, to)`: the instants a move must land between, beside `moveMonth`, where the interaction has a schedule to move. A move outside them is refused.","type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"}},"required":["from","to"],"additionalProperties":false}},"required":["move","cancel","restore","reasonCode","reason"],"additionalProperties":false},"revision":{"type":"string","description":"Pass as `expectedRevision` to change this occurrence."},"schedule":{"anyOf":[{"type":"object","properties":{"targetAt":{"type":"string"},"timeZone":{"type":"string"},"cancelled":{"type":"boolean"}},"required":["targetAt","timeZone","cancelled"],"additionalProperties":false},{"type":"null"}],"description":"Null for execution history."},"title":{"type":"string"},"campaignPaused":{"type":"boolean"},"customerLinkage":{"type":"object","properties":{"kind":{"type":"string","const":"customer"},"customerId":{"type":"string"},"membershipId":{"type":"string"}},"required":["kind","customerId","membershipId"],"additionalProperties":false}},"required":["campaignType","campaignId","occurrenceId","lifecycle","scheduledAt","admittedAt","startedAt","finishedAt","executionId","outcome","capabilities","revision","schedule","title","campaignPaused","customerLinkage"],"additionalProperties":false}},"required":["occurrence"],"additionalProperties":false},"CampaignsCalendarCustomersGetResponse":{"type":"object","properties":{"customer":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"profile":{"type":"object","properties":{"employer":{"anyOf":[{"type":"string"},{"type":"null"}]},"locality":{"anyOf":[{"type":"string"},{"type":"null"}]},"subdivisionCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"countryCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"trigger":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What sent the customer shopping, in their words."}},"required":["employer","locality","subdivisionCode","countryCode","trigger"],"additionalProperties":false}},"required":["id","name","profile"],"additionalProperties":false}},"required":["customer"],"additionalProperties":false},"CampaignsCalendarCandidatesSearchResponse":{"type":"object","properties":{"candidates":{"readOnly":true,"type":"array","items":{"type":"object","properties":{"customerId":{"type":"string"},"name":{"type":"string"},"jobTitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"location":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["customerId","name","jobTitle","location"],"additionalProperties":false}}},"required":["candidates"],"additionalProperties":false},"CampaignsCalendarCommandsCreateRequest":{"type":"object","properties":{"occurrence":{"anyOf":[{"type":"object","properties":{"campaignType":{"type":"string","enum":["discovery","research","experience"]},"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"occurrenceId":{"type":"string","minLength":1,"maxLength":128}},"required":["campaignType","campaignId","occurrenceId"],"additionalProperties":false},{"type":"object","properties":{"campaignType":{"type":"string","enum":["discovery","research","experience"]},"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"cycle":{"type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])$"}},"required":["campaignType","campaignId","cycle"],"additionalProperties":false}],"description":"The occurrence to change, or for a create the campaign's UTC month (`cycle`)."},"expectedRevision":{"description":"The occurrence's `revision` the change was made against: required to move, cancel or undo, absent for a create.","type":"string","minLength":1,"maxLength":128},"change":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"move"},"targetAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"timeZone":{"type":"string","minLength":1,"maxLength":100}},"required":["kind","targetAt","timeZone"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"cancel"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"undo"},"originalCommandId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","originalCommandId"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"create"},"customerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"targetAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"timeZone":{"type":"string","minLength":1,"maxLength":100}},"required":["kind","customerId","targetAt","timeZone"],"additionalProperties":false}]}},"required":["occurrence","change"],"additionalProperties":false},"CampaignsCalendarCommandsCreateResponse":{"type":"object","properties":{"receipt":{"type":"object","properties":{"commandId":{"type":"string","description":"The command id; an undo names it as `originalCommandId`."},"occurrence":{"type":"object","properties":{"campaignType":{"type":"string","enum":["discovery","research","experience"]},"campaignId":{"type":"string"},"occurrenceId":{"type":"string"}},"required":["campaignType","campaignId","occurrenceId"],"additionalProperties":false,"description":"The occurrence the command named; for a create, the occurrence it made."},"resultOccurrence":{"type":"object","properties":{"campaignType":{"type":"string","enum":["discovery","research","experience"]},"campaignId":{"type":"string"},"occurrenceId":{"type":"string"}},"required":["campaignType","campaignId","occurrenceId"],"additionalProperties":false},"before":{"anyOf":[{"type":"object","properties":{"targetAt":{"type":"string"},"timeZone":{"type":"string"},"cancelled":{"type":"boolean"}},"required":["targetAt","timeZone","cancelled"],"additionalProperties":false},{"type":"null"}],"description":"Null for a created occurrence; undoing it cancels it."},"after":{"type":"object","properties":{"targetAt":{"type":"string"},"timeZone":{"type":"string"},"cancelled":{"type":"boolean"}},"required":["targetAt","timeZone","cancelled"],"additionalProperties":false},"revision":{"type":"string"}},"required":["commandId","occurrence","resultOccurrence","before","after","revision"],"additionalProperties":false},"replayed":{"type":"boolean","description":"True when this key's committed receipt was replayed."}},"required":["receipt","replayed"],"additionalProperties":false},"CampaignsCustomerVersionPoliciesUpdateRequest":{"type":"object","properties":{"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The campaign's id."},"policy":{"type":"string","enum":["pinned","latest"],"description":"`latest`, what every campaign already does: new work uses each customer's newest version. `pinned` is no longer a choice and is refused."}},"required":["campaignId","policy"],"additionalProperties":false,"deprecated":true},"CampaignsCustomerVersionPoliciesUpdateResponse":{"type":"object","properties":{"changed":{"type":"boolean","description":"Always false: nothing changes."},"policy":{"type":"string","enum":["pinned","latest"]}},"required":["changed","policy"],"additionalProperties":false},"CampaignsPrecisionQuotesGetResponse":{"type":"object","properties":{"control":{"type":"object","properties":{"available":{"type":"boolean"},"reason":{"type":"string","description":"The product's reason, `ok` when the campaign takes an order (Discovery: `published_pilot` when it starts the customer's own campaign instead)."},"title":{"type":"string"},"detail":{"type":"string"},"action":{"description":"The one next step a refusal offers, when the reader has one.","type":"object","properties":{"label":{"type":"string"},"href":{"type":"string"}},"required":["label","href"],"additionalProperties":false}},"required":["available","reason","title","detail"],"additionalProperties":false,"description":"The campaign's product's verdict on a precision order, for this caller."},"campaignCustomers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The roster the order grows."},"limits":{"type":"object","properties":{"campaignCustomerMax":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The most customers a campaign holds."},"orderCustomerMax":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The most customers one order adds."},"maxAddedCustomers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The most one order adds to this campaign now."}},"required":["campaignCustomerMax","orderCustomerMax","maxAddedCustomers"],"additionalProperties":false},"focus":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"dimensionId":{"type":"string","enum":["audience_mix","channel_mix","regional_mix","age_mix","household_income_mix","education_mix","life_stage_mix","urbanicity_mix","company_size_mix","buyer_role_mix","seniority_mix","occupation_mix","job_mix","trigger_type_mix","intent_stage_mix","language_mix","gender_mix","store"],"description":"A customer attribute's dimension (audience_mix, channel_mix, regional_mix, age_mix, ...), or `store` for a location campaign's store."},"bucketId":{"type":"string","minLength":1,"maxLength":2000,"description":"The bucket's id in that dimension; a store's location key."}},"required":["dimensionId","bucketId"],"additionalProperties":false}},{"type":"null"}],"description":"The buckets the order sources inside and its customers carry; null in the campaign's normal mix."},"order":{"type":"object","properties":{"customers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Customers one order adds: the reading's gap to Standard, or the most the limits and the eligible pool allow."},"reach":{"type":"object","properties":{"customers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"marginPts":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["customers","marginPts"],"additionalProperties":false,"description":"The reading's customers and margin once they are measured; an outcome's expected ones."},"reachable":{"type":"boolean","description":"Whether that reach is Standard; false states the best one order buys."}},"required":["customers","reach","reachable"],"additionalProperties":false},"filled":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Of them, eligible customers already in the organization, admitted at once."},"generated":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Of them, customers generated for the order."},"price":{"anyOf":[{"type":"object","properties":{"customers":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"Customers the order adds."},"recurring":{"anyOf":[{"type":"object","properties":{"productSlug":{"type":"string","minLength":1,"maxLength":160},"dimensionKey":{"type":"string","minLength":1,"maxLength":160},"unitPriceCents":{"type":"integer","minimum":0,"maximum":100000000},"quantity":{"type":"integer","minimum":1,"maximum":1000000},"totalCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"period":{"type":"string","enum":["day","week","month"],"description":"The period the charge repeats over."}},"required":["productSlug","dimensionKey","unitPriceCents","quantity","totalCents","period"],"additionalProperties":false},{"type":"null"}],"description":"The interactions the added customers bring every `period`, at the live price: Discovery's conversation per customer, assistant and lane each month, a recurring Research study's interview per customer each day, week or month, an always-on Experience campaign's visits each month. Null where none repeat."},"once":{"anyOf":[{"type":"object","properties":{"productSlug":{"type":"string","minLength":1,"maxLength":160},"dimensionKey":{"type":"string","minLength":1,"maxLength":160},"unitPriceCents":{"type":"integer","minimum":0,"maximum":100000000},"quantity":{"type":"integer","minimum":1,"maximum":1000000},"totalCents":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["productSlug","dimensionKey","unitPriceCents","quantity","totalCents"],"additionalProperties":false},{"type":"null"}],"description":"The interactions the added customers bring once, at the live price: a Research study that ran once interviews them in a top-up wave, a one-time Experience campaign visits them in a top-up cycle. Null where none."},"oneTime":{"anyOf":[{"type":"object","properties":{"productSlug":{"type":"string","minLength":1,"maxLength":160},"dimensionKey":{"type":"string","minLength":1,"maxLength":160},"unitPriceCents":{"type":"integer","minimum":0,"maximum":100000000},"quantity":{"type":"integer","minimum":1,"maximum":1000000},"totalCents":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["productSlug","dimensionKey","unitPriceCents","quantity","totalCents"],"additionalProperties":false},{"type":"null"}],"description":"Always null: the customers the order generates because the eligible pool runs short are included in the plan and charge nothing. A start still accepts a line a quote named before and charges nothing for it."}},"required":["customers","recurring","once","oneTime"],"additionalProperties":false},{"type":"null"}],"description":"Every charge; pass it unchanged as the start's expectedPrice. Null when the order adds no one."},"unavailableStores":{"type":"array","items":{"type":"object","properties":{"storeKey":{"type":"string","description":"The store, by its location key."},"code":{"type":"string","description":"Why: `STORE_PROFILE_MISSING` when the store has no store profile yet, or one that can't generate customers now (its Refresh, or the campaign's next setup, fixes it); `PRECISION_OVERRIDE_UNSUPPORTED` when its profile doesn't hold the group the order is for."},"message":{"type":"string","description":"The reason in the owner's words."},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The store's name, where its owner knows one; null names it by its key."},"action":{"anyOf":[{"type":"object","properties":{"label":{"type":"string"},"href":{"type":"string"}},"required":["label","href"],"additionalProperties":false},{"type":"null"}],"description":"Where to fix it, where there is one: the store's page, whose Refresh gives it a store profile and which shows what its profile holds."}},"required":["storeKey","code","message","label","action"],"additionalProperties":false},"description":"Stores in the order where no customers can be generated now; each adds only its eligible customers, which `order` and `generated` already count."}},"required":["control","campaignCustomers","limits","focus","order","filled","generated","price","unavailableStores"],"additionalProperties":false},"CampaignsPrecisionOrdersListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"orderId":{"type":"string","description":"The order's id."},"focusKey":{"type":"string","description":"The group the order is for, one key per group."},"focus":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"dimensionId":{"type":"string","enum":["audience_mix","channel_mix","regional_mix","age_mix","household_income_mix","education_mix","life_stage_mix","urbanicity_mix","company_size_mix","buyer_role_mix","seniority_mix","occupation_mix","job_mix","trigger_type_mix","intent_stage_mix","language_mix","gender_mix","store"],"description":"A customer attribute's dimension (audience_mix, channel_mix, regional_mix, age_mix, ...), or `store` for a location campaign's store."},"bucketId":{"type":"string","minLength":1,"maxLength":2000,"description":"The bucket's id in that dimension; a store's location key."}},"required":["dimensionId","bucketId"],"additionalProperties":false}},{"type":"null"}],"description":"The buckets its customers carry; null in the campaign's normal mix."},"state":{"type":"string","enum":["generating","adding","measuring","done","failed"],"description":"`generating` while customers are made, `adding` while they join, `measuring` until each one's first interview or visit ends, `done` after, `failed` when its generation ended before its customers existed."},"customers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Customers the order adds."},"filled":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Of them, eligible customers already in the organization, admitted at once."},"generating":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Of them, customers it generates."},"generated":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Of those, the ones generated so far."},"added":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Customers on the campaign's roster now that it added."},"measured":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Of them, the ones whose first interview or visit completed."},"stores":{"type":"array","items":{"type":"object","properties":{"storeKey":{"type":"string","description":"The store, by its location key."},"generating":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Its share of the customers the order generates."},"state":{"type":"string","enum":["generating","adding","joined","ended"],"description":"`generating` while its customers are made, `adding` until one joins, `joined` once they have, `ended` when its generation failed or was refused, made no one, or none joined in time."},"generated":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Of its share, the ones generated so far."},"joined":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Of those, the ones that joined the campaign."}},"required":["storeKey","generating","state","generated","joined"],"additionalProperties":false},"description":"On a location campaign, each store the order generates in, with how far it has come; empty otherwise."},"startedAt":{"type":"string","description":"When the order was placed, ISO timestamp."}},"required":["orderId","focusKey","focus","state","customers","filled","generating","generated","added","measured","stores","startedAt"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"control":{"anyOf":[{"type":"object","properties":{"available":{"type":"boolean"},"reason":{"type":"string","description":"The product's reason, `ok` when the campaign takes an order (Discovery: `published_pilot` when it starts the customer's own campaign instead)."},"title":{"type":"string"},"detail":{"type":"string"},"action":{"description":"The one next step a refusal offers, when the reader has one.","type":"object","properties":{"label":{"type":"string"},"href":{"type":"string"}},"required":["label","href"],"additionalProperties":false}},"required":["available","reason","title","detail"],"additionalProperties":false,"description":"The campaign's product's verdict on a precision order, for this caller."},{"type":"null"}],"description":"Whether the campaign takes another order for this caller; null when its product's refusal names none. A campaign that no longer exists, or that the organization's Campaigns list does not hold, is not found."}},"required":["data","nextCursor","control"],"additionalProperties":false},"PlatformRunsGetResponse":{"type":"object","properties":{"runId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"status":{"type":"string","enum":["running","succeeded","failed","cancelled","partial_needs_top_up"]},"productSlug":{"type":"string","enum":["ad-copy","alpha","brand-health","brand-kit","competitors","crm-extraction","custom-research","customer-description","customer-generation","discovery","forecast","inspector","journeys","manual-audience","offers","peer-benchmarks","places-enrichment","pricing","product","product-launch","product-roadmap","profile-generation","purchasing","reconciliation","research","sales","url-safety"]},"startedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"completedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]}},"required":["runId","status","productSlug","startedAt","completedAt"],"additionalProperties":false},"PlatformRunsGetV2Response":{"type":"object","properties":{"runId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"status":{"type":"string","enum":["running","succeeded","failed","cancelled","partial_needs_top_up"]},"productSlug":{"type":"string","enum":["ad-copy","alpha","brand-health","brand-kit","competitors","crm-extraction","custom-research","customer-description","customer-edit","customer-generation","discovery","forecast","inspector","journeys","manual-audience","offers","peer-benchmarks","places-enrichment","pricing","product","product-launch","product-roadmap","profile-generation","purchasing","reconciliation","research","sales","url-safety"]},"startedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"completedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]}},"required":["runId","status","productSlug","startedAt","completedAt"],"additionalProperties":false},"PlatformAdminReportsGetResponse":{"type":"object","properties":{"window":{"type":"object","properties":{"range":{"type":"string","enum":["7d","30d","90d"]},"days":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"trendDays":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"The trailing span each trend day counts."},"lookbackFrom":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"First day `lookbackWork` covers."},"from":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"The window's first day."},"to":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"The day after the window's last, today: tomorrow, UTC."}},"required":["range","days","trendDays","lookbackFrom","from","to"],"additionalProperties":false},"adoption":{"type":"object","properties":{"total":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct count over the window."},"days":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"value":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["day","value"],"additionalProperties":false},"description":"Each window day's distinct count over the seven days ending that day."}},"required":["total","days"],"additionalProperties":false,"description":"Members who asked for work from the app or API or changed an Advisor item."},"twins":{"type":"object","properties":{"total":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct count over the window."},"days":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"value":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["day","value"],"additionalProperties":false},"description":"Each window day's distinct count over the seven days ending that day."}},"required":["total","days"],"additionalProperties":false,"description":"Customer twins that took part in a delivered conversation, interview, or experience run of a campaign the customer paid for: the interactions `work` counts with a campaignType."},"decisions":{"type":"object","properties":{"total":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct count over the window."},"days":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"value":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["day","value"],"additionalProperties":false},"description":"Each window day's distinct count over the seven days ending that day."}},"required":["total","days"],"additionalProperties":false,"description":"Recommendations a member first acted on: completed, dismissed, or otherwise moved to a new status."},"work":{"type":"array","items":{"$ref":"#/components/schemas/PlatformWorkItem"},"description":"Delivered work per run identity and completion day in the window."},"lookbackWork":{"type":"array","items":{"$ref":"#/components/schemas/PlatformWorkItem"},"description":"Delivered work in the days before the window its first trend days reach."},"team":{"type":"object","properties":{"members":{"type":"integer","minimum":0,"maximum":9007199254740991},"activeCurrentMembers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Current members active in the window."},"pendingInvitations":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["members","activeCurrentMembers","pendingInvitations"],"additionalProperties":false}},"required":["window","adoption","twins","decisions","work","lookbackWork","team"],"additionalProperties":false},"SupportMessagesSendRequest":{"type":"object","properties":{"message":{"type":"string","minLength":1,"maxLength":5000,"description":"The message for Point11 support"}},"required":["message"],"additionalProperties":false},"SupportMessagesSendResponse":{"type":"object","properties":{"operationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The Idempotency-Key this message was stored under"},"deliveryOutcome":{"type":"string","enum":["sent","pending"],"description":"`sent`: support received it. `pending`: stored and Point11 keeps retrying delivery."}},"required":["operationId","deliveryOutcome"],"additionalProperties":false},"SupportHelpConversationsStartRequest":{"type":"object","properties":{"replacesConversationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"additionalProperties":false},"__schema0":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"$ref":"#/components/schemas/__schema0"}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/__schema0"}}]},"__schema1":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"$ref":"#/components/schemas/__schema1"}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/__schema1"}}]},"SupportHelpConversationsStartResponse":{"type":"object","properties":{"conversationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"eveSession":{"anyOf":[{"type":"object","properties":{"sessionId":{"type":"string"},"streamIndex":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["sessionId","streamIndex"],"additionalProperties":false},{"type":"null"}]},"deploymentId":{"type":"string"},"messages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string","enum":["system","user","assistant"]},"parts":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"}},"required":["type"],"additionalProperties":{"$ref":"#/components/schemas/__schema0"}}}},"required":["id","role","parts"],"additionalProperties":{"$ref":"#/components/schemas/__schema1"}}},"pendingMessage":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"turnIntentId":{"type":"string"},"userMessageId":{"type":"string"}},"required":["message","turnIntentId","userMessageId"],"additionalProperties":false},{"type":"null"}]},"pathname":{"type":"string"}},"required":["conversationId","eveSession","deploymentId","messages","pendingMessage","pathname"],"additionalProperties":false},"BusinessRevenueTrackingConfigurationsCreateV2Request":{"type":"object","properties":{"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"locationKey":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"expectedProfileVersionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"values":{"type":"object","properties":{"annualSalesUsd":{"type":"number","exclusiveMinimum":0,"maximum":90071992547409.9},"marketSharePct":{"type":"number","exclusiveMinimum":0,"maximum":100},"aiInfluencePct":{"type":"number","minimum":0,"maximum":100}},"required":["annualSalesUsd","marketSharePct","aiInfluencePct"],"additionalProperties":false}},"required":["businessProfileId","expectedProfileVersionId","lineId","values"],"additionalProperties":false},"BusinessRevenueTrackingConfigurationsCreateV2Response":{"type":"object","properties":{"profile":{"$ref":"#/components/schemas/BusinessProfile"}},"required":["profile"],"additionalProperties":false},"BusinessRevenueTrackingConfigurationsCreateRequest":{"type":"object","properties":{"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"locationKey":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"expectedProfileVersionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"values":{"type":"object","properties":{"annualSalesUsd":{"type":"number","exclusiveMinimum":0,"maximum":90071992547409.9},"marketSharePct":{"type":"number","exclusiveMinimum":0,"maximum":100},"aiInfluencePct":{"type":"number","minimum":0,"maximum":100}},"required":["annualSalesUsd","marketSharePct","aiInfluencePct"],"additionalProperties":false}},"required":["businessProfileId","expectedProfileVersionId","lineId","values"],"additionalProperties":false,"deprecated":true},"BusinessRevenueTrackingConfigurationsCreateResponse":{"type":"object","properties":{"profile":{"$ref":"#/components/schemas/BusinessProfile2"}},"required":["profile"],"additionalProperties":false},"BusinessRevenueTrackingConfigurationsUpdateV2Request":{"type":"object","properties":{"configurationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"expectedRevision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"values":{"type":"object","properties":{"annualSalesUsd":{"type":"number","exclusiveMinimum":0,"maximum":90071992547409.9},"marketSharePct":{"type":"number","exclusiveMinimum":0,"maximum":100},"aiInfluencePct":{"type":"number","minimum":0,"maximum":100}},"required":["annualSalesUsd","marketSharePct","aiInfluencePct"],"additionalProperties":false}},"required":["configurationId","expectedRevision","values"],"additionalProperties":false},"BusinessRevenueTrackingConfigurationsUpdateV2Response":{"type":"object","properties":{"profile":{"$ref":"#/components/schemas/BusinessProfile"}},"required":["profile"],"additionalProperties":false},"BusinessRevenueTrackingConfigurationsUpdateRequest":{"type":"object","properties":{"configurationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"expectedRevision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"values":{"type":"object","properties":{"annualSalesUsd":{"type":"number","exclusiveMinimum":0,"maximum":90071992547409.9},"marketSharePct":{"type":"number","exclusiveMinimum":0,"maximum":100},"aiInfluencePct":{"type":"number","minimum":0,"maximum":100}},"required":["annualSalesUsd","marketSharePct","aiInfluencePct"],"additionalProperties":false}},"required":["configurationId","expectedRevision","values"],"additionalProperties":false,"deprecated":true},"BusinessRevenueTrackingConfigurationsUpdateResponse":{"type":"object","properties":{"profile":{"$ref":"#/components/schemas/BusinessProfile2"}},"required":["profile"],"additionalProperties":false},"BusinessRevenueTrackingConfigurationsDeleteV2Request":{"type":"object","properties":{"configurations":{"minItems":1,"type":"array","items":{"type":"object","properties":{"configurationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"expectedRevision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["configurationId","expectedRevision"],"additionalProperties":false}}},"required":["configurations"],"additionalProperties":false},"BusinessRevenueTrackingConfigurationsDeleteV2Response":{"type":"object","properties":{"profiles":{"type":"array","items":{"type":"object","properties":{"businessProfileId":{"type":"string"},"locationKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"scopeLabel":{"type":"string"},"annualSalesBasis":{"type":"string"},"profileVersionId":{"type":"string"},"brandName":{"type":"string"},"normalizedUrl":{"type":"string"},"generatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"lines":{"$ref":"#/components/schemas/BusinessLines"}},"required":["businessProfileId","locationKey","scopeLabel","annualSalesBasis","profileVersionId","brandName","normalizedUrl","generatedAt","lines"],"additionalProperties":false}}},"required":["profiles"],"additionalProperties":false},"BusinessRevenueTrackingConfigurationsDeleteRequest":{"type":"object","properties":{"configurations":{"minItems":1,"type":"array","items":{"type":"object","properties":{"configurationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"expectedRevision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["configurationId","expectedRevision"],"additionalProperties":false}}},"required":["configurations"],"additionalProperties":false,"deprecated":true},"BusinessRevenueTrackingConfigurationsDeleteResponse":{"type":"object","properties":{"profiles":{"$ref":"#/components/schemas/BusinessProfiles"}},"required":["profiles"],"additionalProperties":false},"BusinessRevenueTrackingWorkspacesGetV2Response":{"type":"object","properties":{"profiles":{"type":"array","items":{"type":"object","properties":{"businessProfileId":{"type":"string"},"locationKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"scopeLabel":{"type":"string"},"annualSalesBasis":{"type":"string"},"profileVersionId":{"type":"string"},"brandName":{"type":"string"},"normalizedUrl":{"type":"string"},"generatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"lines":{"type":"array","items":{"type":"object","properties":{"configurationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"revision":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"source":{"type":"string","enum":["research","configuration"]},"lineId":{"type":"string"},"lineName":{"type":"string"},"lineAvailable":{"type":"boolean"},"revenueWeightPct":{"type":"number"},"samYear":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"annualSalesUsd":{"anyOf":[{"type":"number"},{"type":"null"}]},"marketSharePct":{"anyOf":[{"type":"number"},{"type":"null"}]},"aiInfluencePct":{"anyOf":[{"type":"number"},{"type":"null"}]},"serviceableAvailableMarketUsd":{"anyOf":[{"type":"number"},{"type":"null"}]},"aiInfluencedServiceableAvailableMarketUsd":{"anyOf":[{"type":"number"},{"type":"null"}]},"aiInfluencedSalesUsd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Annual sales × AI influence: the brand's own sales AI assistants influence. Dollars are a share of the AI-influenced market, not of these sales."},"winRate":{"anyOf":[{"type":"object","properties":{"successes":{"type":"integer","minimum":0,"maximum":9007199254740991},"trials":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"ratePct":{"type":"number"}},"required":["successes","trials","ratePct"],"additionalProperties":false},{"type":"null"}],"description":"Every Discovery campaign's measurement of the line at this scope today, pooled; null when none measured it."},"winRatePoint":{"anyOf":[{"type":"object","properties":{"pointValueUsd":{"type":"number","description":"Dollars one point of the rate is worth on the line."},"basis":{"type":"string","enum":["ceiling"],"description":"The bound that sets it: always ceiling, the AI-influenced market ÷ 100, whatever the rate."}},"required":["pointValueUsd","basis"],"additionalProperties":false},{"type":"null"}],"description":"One point of winRate: the AI-influenced market ÷ 100; null without a win rate or complete assumptions."}},"required":["configurationId","revision","source","lineId","lineName","lineAvailable","revenueWeightPct","samYear","annualSalesUsd","marketSharePct","aiInfluencePct","serviceableAvailableMarketUsd","aiInfluencedServiceableAvailableMarketUsd","aiInfluencedSalesUsd","winRate","winRatePoint"],"additionalProperties":false}}},"required":["businessProfileId","locationKey","scopeLabel","annualSalesBasis","profileVersionId","brandName","normalizedUrl","generatedAt","lines"],"additionalProperties":false}}},"required":["profiles"],"additionalProperties":false},"BusinessRevenueTrackingWorkspacesGetResponse":{"type":"object","properties":{"profiles":{"$ref":"#/components/schemas/BusinessProfiles"}},"required":["profiles"],"additionalProperties":false},"BusinessRevenueTrackingLocationCatalogsGetResponse":{"type":"object","properties":{"locations":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"}},"required":["key","label"],"additionalProperties":false}}},"required":["locations"],"additionalProperties":false},"BusinessProfileSelectionsGetResponse":{"type":"object","properties":{"selected":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"key":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"}},"required":["id","key","name","url"],"additionalProperties":false},{"type":"null"}]},"hasMore":{"type":"boolean"},"companySales":{"anyOf":[{"type":"object","properties":{"annualSalesUsd":{"type":"number"},"revenueLines":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["annualSalesUsd","revenueLines"],"additionalProperties":false},{"type":"null"}]}},"required":["selected","hasMore"],"additionalProperties":false},"BusinessProfilesListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"profileKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"type":"string"},"normalizedUrl":{"type":"string"},"url":{"type":"string","description":"The website a campaign on this profile measures: its own, or for a described profile the one its research found (empty when it found none)"},"storeCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["id","profileKey","label","normalizedUrl","url","storeCount"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"BusinessRevenueLinesListV4Response":{"type":"object","properties":{"data":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"locationKey":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Null at company scope."},"revenueLineId":{"type":"string"},"name":{"type":"string"},"annualSalesUsd":{"type":"number"},"aiInfluencePct":{"type":"number"},"serviceableAvailableMarketUsd":{"type":"number","description":"SAM: annual sales ÷ market share."},"aiInfluencedSalesUsd":{"type":"number","description":"Annual sales × AI influence: the brand's own sales AI assistants influence."},"aiInfluencedMarketUsd":{"type":"number","description":"SAM × AI influence, the line's AI-influenced market a year: one point of a rate is a hundredth of it."},"winRate":{"anyOf":[{"type":"object","properties":{"successes":{"type":"integer","minimum":0,"maximum":9007199254740991},"trials":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"ratePct":{"type":"number"}},"required":["successes","trials","ratePct"],"additionalProperties":false},{"type":"null"}]},"siteSuccess":{"anyOf":[{"type":"object","properties":{"successes":{"type":"integer","minimum":0,"maximum":9007199254740991},"trials":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"ratePct":{"type":"number"}},"required":["successes","trials","ratePct"],"additionalProperties":false},{"type":"null"}]},"winRatePoint":{"anyOf":[{"type":"object","properties":{"pointValueUsd":{"type":"number","description":"Dollars one point of the rate is worth on the line."},"basis":{"type":"string","enum":["ceiling"],"description":"The bound that sets it: always ceiling, the AI-influenced market ÷ 100, whatever the rate."}},"required":["pointValueUsd","basis"],"additionalProperties":false},{"type":"null"}],"description":"One point of winRate: aiInfluencedMarketUsd ÷ 100; null without a Discovery measurement."},"influencedUsd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"winRatePoint × win rate: the share of the AI-influenced market the brand's wins capture, a year."},"influenceableUsd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"winRatePoint × 100: revenue influenced at a 100% win rate."},"counted":{"type":"boolean"},"measuredBy":{"type":"array","items":{"type":"object","properties":{"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"product":{"type":"string","enum":["discovery","experience"]}},"required":["campaignId","product"],"additionalProperties":false}},"experienceScore":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The line's Experience Score (0 to 100): the mean of the Experience campaigns' scores on the line, each weighted by its judged journeys; a campaign with no score is left out."},"matchedPairs":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Matched pairs the gap rests on: one per customer journey on our website matched to the same customer's on one competitor's, so a customer who shopped three competitors is three pairs."},"ourMatchedScore":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Our Experience Score averaged over the matched pairs."},"competitorScore":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The competitors' Experience Scores averaged over the same matched pairs."},"gapPts":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"ourMatchedScore less competitorScore, in points."},"experiencePoint":{"anyOf":[{"type":"object","properties":{"pointValueUsd":{"type":"number","description":"Dollars one point of the rate is worth on the line."},"basis":{"type":"string","enum":["ceiling"],"description":"The bound that sets it: always ceiling, the AI-influenced market ÷ 100, whatever the rate."}},"required":["pointValueUsd","basis"],"additionalProperties":false},{"type":"null"}],"description":"One point of Experience Score gap where the product lives (at company scope, else at each location whose own product it is): aiInfluencedMarketUsd ÷ 100; null at a location when the company line has market assumptions, and without a matched pair scored on both sides."},"experienceUsd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"experiencePoint × gapPts, plus or minus, valued once where the product lives; null at a location when the company line has market assumptions, and when no matched pair has a score on both sides."}},"required":["businessProfileId","locationKey","revenueLineId","name","annualSalesUsd","aiInfluencePct","serviceableAvailableMarketUsd","aiInfluencedSalesUsd","aiInfluencedMarketUsd","winRate","siteSuccess","winRatePoint","influencedUsd","influenceableUsd","counted","measuredBy","experienceScore","matchedPairs","ourMatchedScore","competitorScore","gapPts","experiencePoint","experienceUsd"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"BusinessRevenueLinesListV3Response":{"type":"object","properties":{"data":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"locationKey":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Null at company scope."},"revenueLineId":{"type":"string"},"name":{"type":"string"},"worthUsd":{"type":"number"},"winRate":{"anyOf":[{"type":"object","properties":{"successes":{"type":"integer","minimum":0,"maximum":9007199254740991},"trials":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"ratePct":{"type":"number"}},"required":["successes","trials","ratePct"],"additionalProperties":false},{"type":"null"}]},"siteSuccess":{"anyOf":[{"type":"object","properties":{"successes":{"type":"integer","minimum":0,"maximum":9007199254740991},"trials":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"ratePct":{"type":"number"}},"required":["successes","trials","ratePct"],"additionalProperties":false},{"type":"null"}]},"influencedUsd":{"anyOf":[{"type":"number"},{"type":"null"}]},"counted":{"type":"boolean"},"measuredBy":{"type":"array","items":{"type":"object","properties":{"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"product":{"type":"string","enum":["discovery","experience"]}},"required":["campaignId","product"],"additionalProperties":false}},"experienceScore":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The line's Experience Score (0 to 100): the mean of the Experience campaigns' scores on the line, each weighted by its judged journeys; a campaign with no score is left out."},"matchedPairs":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Matched pairs the gap rests on: one per customer journey on our website matched to the same customer's on one competitor's, so a customer who shopped three competitors is three pairs."},"ourMatchedScore":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Our Experience Score averaged over the matched pairs."},"competitorScore":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The competitors' Experience Scores averaged over the same matched pairs."},"gapPts":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"ourMatchedScore less competitorScore, in points."},"experienceUsd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Experience dollars as business_revenue_lines_list_v4 values them, plus or minus, valued once where the product lives; null at a location when the company line has market assumptions, and when no matched pair has a score on both sides."}},"required":["businessProfileId","locationKey","revenueLineId","name","worthUsd","winRate","siteSuccess","influencedUsd","counted","measuredBy","experienceScore","matchedPairs","ourMatchedScore","competitorScore","gapPts","experienceUsd"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"BusinessRevenueLinesListV2Response":{"type":"object","properties":{"data":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"locationKey":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Null at company scope."},"revenueLineId":{"type":"string"},"name":{"type":"string"},"worthUsd":{"type":"number"},"winRate":{"anyOf":[{"type":"object","properties":{"successes":{"type":"integer","minimum":0,"maximum":9007199254740991},"trials":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"ratePct":{"type":"number"},"marginPct":{"type":"number","description":"Half-width of the rate's 95% interval, in points."}},"required":["successes","trials","ratePct","marginPct"],"additionalProperties":false},{"type":"null"}]},"siteSuccess":{"anyOf":[{"type":"object","properties":{"successes":{"type":"integer","minimum":0,"maximum":9007199254740991},"trials":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"ratePct":{"type":"number"},"marginPct":{"type":"number","description":"Half-width of the rate's 95% interval, in points."}},"required":["successes","trials","ratePct","marginPct"],"additionalProperties":false},{"type":"null"}]},"influencedUsd":{"anyOf":[{"type":"number"},{"type":"null"}]},"counted":{"type":"boolean"},"measuredBy":{"type":"array","items":{"type":"object","properties":{"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"product":{"type":"string","enum":["discovery","experience"]}},"required":["campaignId","product"],"additionalProperties":false}},"experienceScore":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The line's Experience Score (0 to 100): the mean of the Experience campaigns' scores on the line, each weighted by its judged journeys; a campaign with no score is left out."},"matchedPairs":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Matched pairs the gap rests on: one per customer journey on our website matched to the same customer's on one competitor's, so a customer who shopped three competitors is three pairs."},"ourMatchedScore":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Our Experience Score averaged over the matched pairs."},"competitorScore":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The competitors' Experience Scores averaged over the same matched pairs."},"gapPts":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"ourMatchedScore less competitorScore, in points."},"gapWithinNoise":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Always null: no figure carries a noise flag. The dollars are stated either way."},"experienceUsd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Experience dollars as business_revenue_lines_list_v4 values them, plus or minus, valued once where the product lives; null at a location when the company line has market assumptions, and when no matched pair has a score on both sides."}},"required":["businessProfileId","locationKey","revenueLineId","name","worthUsd","winRate","siteSuccess","influencedUsd","counted","measuredBy","experienceScore","matchedPairs","ourMatchedScore","competitorScore","gapPts","gapWithinNoise","experienceUsd"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"BusinessRevenueLinesListResponse":{"type":"object","properties":{"data":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"locationKey":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Null at company scope."},"revenueLineId":{"type":"string"},"name":{"type":"string"},"worthUsd":{"type":"number"},"winRate":{"anyOf":[{"type":"object","properties":{"successes":{"type":"integer","minimum":0,"maximum":9007199254740991},"trials":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"ratePct":{"type":"number"},"marginPct":{"type":"number","description":"Half-width of the rate's 95% interval, in points."}},"required":["successes","trials","ratePct","marginPct"],"additionalProperties":false},{"type":"null"}]},"siteSuccess":{"anyOf":[{"type":"object","properties":{"successes":{"type":"integer","minimum":0,"maximum":9007199254740991},"trials":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"ratePct":{"type":"number"},"marginPct":{"type":"number","description":"Half-width of the rate's 95% interval, in points."}},"required":["successes","trials","ratePct","marginPct"],"additionalProperties":false},{"type":"null"}]},"influencedUsd":{"anyOf":[{"type":"number"},{"type":"null"}]},"counted":{"type":"boolean"},"measuredBy":{"type":"array","items":{"type":"object","properties":{"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"product":{"type":"string","enum":["discovery","experience"]}},"required":["campaignId","product"],"additionalProperties":false}},"lostOnSiteUsd":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["businessProfileId","locationKey","revenueLineId","name","worthUsd","winRate","siteSuccess","influencedUsd","counted","measuredBy","lostOnSiteUsd"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"BusinessRevenueSummariesGetV3Response":{"type":"object","properties":{"days":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"totals":{"$ref":"#/components/schemas/BusinessTotals"},"profiles":{"type":"array","items":{"type":"object","properties":{"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"totals":{"$ref":"#/components/schemas/BusinessTotals"}},"required":["businessProfileId","totals"],"additionalProperties":false}}},"required":["day","totals","profiles"],"additionalProperties":false}}},"required":["days"],"additionalProperties":false},"BusinessRevenueSummariesGetV2Response":{"type":"object","properties":{"days":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"totals":{"$ref":"#/components/schemas/BusinessItemTotals"},"profiles":{"type":"array","items":{"type":"object","properties":{"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"totals":{"$ref":"#/components/schemas/BusinessItemTotals"}},"required":["businessProfileId","totals"],"additionalProperties":false}}},"required":["day","totals","profiles"],"additionalProperties":false}}},"required":["days"],"additionalProperties":false},"BusinessRevenueSummariesGetResponse":{"type":"object","properties":{"days":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"totals":{"type":"object","properties":{"worthUsd":{"type":"number"},"influencedUsd":{"anyOf":[{"type":"number"},{"type":"null"}]},"lostOnSiteUsd":{"anyOf":[{"type":"number"},{"type":"null"}]},"valuedLineCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"lineCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"measuredLineCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct products (revenue lines) a current Discovery run measured that day, with or without market assumptions in Tools › Products; above valuedLineCount when measured lines lack them."}},"required":["worthUsd","influencedUsd","lostOnSiteUsd","valuedLineCount","lineCount","measuredLineCount"],"additionalProperties":false},"profiles":{"type":"array","items":{"type":"object","properties":{"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"totals":{"type":"object","properties":{"worthUsd":{"type":"number"},"influencedUsd":{"anyOf":[{"type":"number"},{"type":"null"}]},"lostOnSiteUsd":{"anyOf":[{"type":"number"},{"type":"null"}]},"valuedLineCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"lineCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"measuredLineCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct products (revenue lines) a current Discovery run measured that day, with or without market assumptions in Tools › Products; above valuedLineCount when measured lines lack them."}},"required":["worthUsd","influencedUsd","lostOnSiteUsd","valuedLineCount","lineCount","measuredLineCount"],"additionalProperties":false}},"required":["businessProfileId","totals"],"additionalProperties":false}}},"required":["day","totals","profiles"],"additionalProperties":false}}},"required":["days"],"additionalProperties":false},"BusinessRevenueLinesCreateV2Request":{"type":"object","properties":{"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":160},"description":{"type":"string","minLength":1,"maxLength":1200,"description":"What the line sells."},"audiencesFromRevenueLineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"A current product of the profile (its revenue line id) whose audiences the new line takes."},"annualSalesUsd":{"type":"number","exclusiveMinimum":0,"maximum":90071992547409.9},"marketSharePct":{"description":"Annual sales as a percentage of the line's serviceable market.","type":"number","exclusiveMinimum":0,"maximum":100},"aiInfluencePct":{"description":"Defaults to 20.","type":"number","minimum":0,"maximum":100}},"required":["businessProfileId","name","description","audiencesFromRevenueLineId","annualSalesUsd","marketSharePct"],"additionalProperties":false},"BusinessRevenueLinesCreateV2Response":{"type":"object","properties":{"revenueLine":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},"profile":{"type":"object","properties":{"businessProfileId":{"type":"string"},"locationKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"scopeLabel":{"type":"string"},"annualSalesBasis":{"type":"string"},"profileVersionId":{"type":"string"},"brandName":{"type":"string"},"normalizedUrl":{"type":"string"},"generatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"lines":{"$ref":"#/components/schemas/BusinessLines"}},"required":["businessProfileId","locationKey","scopeLabel","annualSalesBasis","profileVersionId","brandName","normalizedUrl","generatedAt","lines"],"additionalProperties":false,"description":"The profile's company ledger with the new line, as business_revenue_tracking_workspaces_get_v2 reads it, without the measured win rate."}},"required":["revenueLine","profile"],"additionalProperties":false},"BusinessRevenueLinesCreateRequest":{"type":"object","properties":{"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":160},"description":{"type":"string","minLength":1,"maxLength":1200,"description":"What the line sells."},"audiencesFromRevenueLineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"A current product of the profile (its revenue line id) whose audiences the new line takes."},"annualSalesUsd":{"type":"number","exclusiveMinimum":0,"maximum":90071992547409.9},"marketSharePct":{"description":"Annual sales as a percentage of the line's serviceable market.","type":"number","exclusiveMinimum":0,"maximum":100},"aiInfluencePct":{"description":"Defaults to 20.","type":"number","minimum":0,"maximum":100}},"required":["businessProfileId","name","description","audiencesFromRevenueLineId","annualSalesUsd","marketSharePct"],"additionalProperties":false,"deprecated":true},"BusinessRevenueLinesCreateResponse":{"type":"object","properties":{"revenueLine":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},"profile":{"type":"object","properties":{"businessProfileId":{"type":"string"},"locationKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"scopeLabel":{"type":"string"},"annualSalesBasis":{"type":"string"},"profileVersionId":{"type":"string"},"brandName":{"type":"string"},"normalizedUrl":{"type":"string"},"generatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"lines":{"$ref":"#/components/schemas/BusinessItemLines"}},"required":["businessProfileId","locationKey","scopeLabel","annualSalesBasis","profileVersionId","brandName","normalizedUrl","generatedAt","lines"],"additionalProperties":false,"description":"The profile's company ledger with the new line, as business_revenue_tracking_workspaces_get_v1 reads it."}},"required":["revenueLine","profile"],"additionalProperties":false},"BusinessGoalsListResponse":{"type":"object","properties":{"data":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/BusinessDataItem"}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"BusinessGoalsGetResponse":{"type":"object","properties":{"goal":{"$ref":"#/components/schemas/BusinessDataItem"}},"required":["goal"],"additionalProperties":false},"BusinessGoalsCreateRequest":{"type":"object","properties":{"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"metric":{"type":"string","enum":["discovery_brand_win_rate","discovery_brand_share","experience_pass_rate","inspector_score","google_ads_quality_score"]},"campaignId":{"default":null,"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"googleAdsAccountId":{"default":null,"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"targetValue":{"type":"number"},"dueOn":{"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}],"description":"The last day of the goal, YYYY-MM-DD; null for an ongoing goal with no deadline"}},"required":["businessProfileId","metric","targetValue","dueOn"],"additionalProperties":false},"BusinessGoalsCreateResponse":{"type":"object","properties":{"goal":{"$ref":"#/components/schemas/BusinessDataItem"}},"required":["goal"],"additionalProperties":false},"BusinessGoalsUpdateRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"expectedRevision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"targetValue":{"type":"number"},"dueOn":{"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}],"description":"The last day of the goal, YYYY-MM-DD; null for an ongoing goal with no deadline"}},"required":["id","expectedRevision","targetValue","dueOn"],"additionalProperties":false},"BusinessGoalsUpdateResponse":{"type":"object","properties":{"goal":{"$ref":"#/components/schemas/BusinessDataItem"}},"required":["goal"],"additionalProperties":false},"BusinessGoalsArchiveRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"expectedRevision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["id","expectedRevision"],"additionalProperties":false},"BusinessGoalsArchiveResponse":{"type":"object","properties":{"goal":{"$ref":"#/components/schemas/BusinessDataItem"}},"required":["goal"],"additionalProperties":false},"BusinessGoalsRestoreRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"expectedRevision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["id","expectedRevision"],"additionalProperties":false},"BusinessGoalsRestoreResponse":{"type":"object","properties":{"goal":{"$ref":"#/components/schemas/BusinessDataItem"}},"required":["goal"],"additionalProperties":false},"BusinessGoalsDeleteRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"expectedRevision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["id","expectedRevision"],"additionalProperties":false},"BusinessGoalsDeleteResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["id"],"additionalProperties":false},"BusinessGoalSubjectsListResponse":{"type":"object","properties":{"data":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"metric":{"type":"string","enum":["discovery_brand_win_rate","discovery_brand_share","experience_pass_rate","inspector_score","google_ads_quality_score"]},"metricLabel":{"type":"string"},"product":{"type":"string"},"unit":{"type":"string","enum":["percent","score","quality_score"]},"min":{"type":"number"},"max":{"type":"number"},"campaignId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"googleAdsAccountId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"subjectLabel":{"type":"string"},"campaignTargetKind":{"anyOf":[{"type":"string","enum":["profile","physical_locations"]},{"type":"null"}]},"campaignForecastAudience":{"type":"boolean","description":"Whether a Discovery campaign's customers are its forecast's alone (forecast mode, as Bootup's Forecast campaign); false for any other subject."},"current":{"anyOf":[{"type":"object","properties":{"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"low":{"anyOf":[{"type":"number"},{"type":"null"}]},"high":{"anyOf":[{"type":"number"},{"type":"null"}]},"readAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"caption":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the reading stands on, in its owner's words, shown beside it; null where the owner states none, as every metric's owner does now"}},"required":["value","low","high","readAt","caption"],"additionalProperties":false},{"type":"null"}]},"onePointUsd":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["metric","metricLabel","product","unit","min","max","campaignId","googleAdsAccountId","subjectLabel","campaignTargetKind","campaignForecastAudience","current","onePointUsd"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"BusinessGoalSummariesGetResponse":{"type":"object","properties":{"total":{"type":"integer","minimum":0,"maximum":9007199254740991},"counts":{"type":"object","additionalProperties":false,"required":["no_reading","reached","on_track","within_margin","behind","below_target","missed","stale"],"properties":{"no_reading":{"type":"integer","minimum":0,"maximum":9007199254740991},"reached":{"type":"integer","minimum":0,"maximum":9007199254740991},"on_track":{"type":"integer","minimum":0,"maximum":9007199254740991},"within_margin":{"type":"integer","minimum":0,"maximum":9007199254740991},"behind":{"type":"integer","minimum":0,"maximum":9007199254740991},"below_target":{"type":"integer","minimum":0,"maximum":9007199254740991},"missed":{"type":"integer","minimum":0,"maximum":9007199254740991},"stale":{"type":"integer","minimum":0,"maximum":9007199254740991}}},"behind":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"profileName":{"type":"string"},"metricLabel":{"type":"string"},"subjectLabel":{"type":"string"}},"required":["id","businessProfileId","profileName","metricLabel","subjectLabel"],"additionalProperties":false}}},"required":["total","counts","behind"],"additionalProperties":false},"BusinessGoogleAdsConnectionsGetResponse":{"type":"object","properties":{"configured":{"type":"boolean"},"sample":{"type":"boolean"},"connection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"status":{"type":"string","enum":["authorizing","active","revocation_pending","superseded","revoked"]},"connectedAt":{"type":"string"},"connectedBy":{"type":"string"}},"required":["id","status","connectedAt","connectedBy"],"additionalProperties":false},{"type":"null"}]},"accounts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customerId":{"type":"string"},"loginCustomerId":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"currencyCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"timeZone":{"anyOf":[{"type":"string"},{"type":"null"}]},"isTestAccount":{"type":"boolean"},"status":{"type":"string","enum":["available","selected","access_lost"]},"syncedThrough":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastSyncAttemptAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastSyncErrorCode":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","customerId","loginCustomerId","name","currencyCode","timeZone","isTestAccount","status","syncedThrough","lastSyncAttemptAt","lastSyncErrorCode"],"additionalProperties":false}}},"required":["configured","sample","connection","accounts"],"additionalProperties":false},"BusinessGoogleAdsAccountsDiscoverRequest":{"type":"object","properties":{},"additionalProperties":false},"BusinessGoogleAdsAccountsDiscoverResponse":{"type":"object","properties":{"accounts":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["accounts"],"additionalProperties":false},"BusinessGoogleAdsAccountsSelectRequest":{"type":"object","properties":{"customerIds":{"maxItems":500,"type":"array","items":{"type":"string","pattern":"^\\d{10}$"}}},"required":["customerIds"],"additionalProperties":false},"BusinessGoogleAdsAccountsSelectResponse":{"type":"object","properties":{"selected":{"type":"integer","minimum":0,"maximum":9007199254740991},"syncStarted":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["selected","syncStarted"],"additionalProperties":false},"BusinessGoogleAdsAccountsSyncRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"from":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"through":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"}},"additionalProperties":false},"BusinessGoogleAdsAccountsSyncResponse":{"type":"object","properties":{"queued":{"type":"integer","minimum":0,"maximum":9007199254740991},"accountIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"requestedAt":{"type":"string"}},"required":["queued","accountIds","requestedAt"],"additionalProperties":false},"BusinessGoogleAdsQualityScoresGetResponse":{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"window":{"type":"object","properties":{"from":{"type":"string"},"through":{"type":"string"}},"required":["from","through"],"additionalProperties":false},"history":{"anyOf":[{"type":"object","properties":{"from":{"type":"string"},"through":{"type":"string"}},"required":["from","through"],"additionalProperties":false},{"type":"null"}]},"weightedQualityScore":{"anyOf":[{"type":"number"},{"type":"null"}]},"weightedQualityScoreFirstWeek":{"anyOf":[{"type":"number"},{"type":"null"}]},"weightedQualityScoreLastWeek":{"anyOf":[{"type":"number"},{"type":"null"}]},"keywords":{"type":"object","properties":{"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"scored":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unscored":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["total","scored","unscored"],"additionalProperties":false},"distribution":{"minItems":10,"maxItems":10,"type":"array","items":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"impressions":{"type":"number"},"costMicros":{"type":"number"},"lowScoreCostShare":{"anyOf":[{"type":"number"},{"type":"null"}]},"components":{"type":"object","properties":{"expectedCtr":{"type":"object","properties":{"below_average":{"type":"number"},"average":{"type":"number"},"above_average":{"type":"number"},"unknown":{"type":"number"}},"required":["below_average","average","above_average","unknown"],"additionalProperties":false},"adRelevance":{"type":"object","properties":{"below_average":{"type":"number"},"average":{"type":"number"},"above_average":{"type":"number"},"unknown":{"type":"number"}},"required":["below_average","average","above_average","unknown"],"additionalProperties":false},"landingPageExperience":{"type":"object","properties":{"below_average":{"type":"number"},"average":{"type":"number"},"above_average":{"type":"number"},"unknown":{"type":"number"}},"required":["below_average","average","above_average","unknown"],"additionalProperties":false}},"required":["expectedCtr","adRelevance","landingPageExperience"],"additionalProperties":false},"trend":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"weightedQualityScore":{"anyOf":[{"type":"number"},{"type":"null"}]},"impressions":{"type":"number"}},"required":["date","weightedQualityScore","impressions"],"additionalProperties":false}}},"required":["accountId","window","history","weightedQualityScore","weightedQualityScoreFirstWeek","weightedQualityScoreLastWeek","keywords","distribution","impressions","costMicros","lowScoreCostShare","components","trend"],"additionalProperties":false},"BusinessGoogleAdsKeywordsListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"adGroupId":{"type":"string"},"criterionId":{"type":"string"},"keywordText":{"type":"string"},"matchType":{"anyOf":[{"type":"string"},{"type":"null"}]},"campaignName":{"anyOf":[{"type":"string"},{"type":"null"}]},"adGroupName":{"anyOf":[{"type":"string"},{"type":"null"}]},"qualityScore":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"expectedCtr":{"anyOf":[{"type":"string","enum":["below_average","average","above_average"]},{"type":"null"}]},"adRelevance":{"anyOf":[{"type":"string","enum":["below_average","average","above_average"]},{"type":"null"}]},"landingPageExperience":{"anyOf":[{"type":"string","enum":["below_average","average","above_average"]},{"type":"null"}]},"qualityScore7DaysAgo":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"qualityScore30DaysAgo":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"impressions":{"type":"number"},"clicks":{"type":"number"},"costMicros":{"type":"number"}},"required":["adGroupId","criterionId","keywordText","matchType","campaignName","adGroupName","qualityScore","expectedCtr","adRelevance","landingPageExperience","qualityScore7DaysAgo","qualityScore30DaysAgo","impressions","clicks","costMicros"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"total":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["data","nextCursor","accountId","total"],"additionalProperties":false},"BusinessGoogleAdsSearchTermsListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"searchTerm":{"type":"string"},"adGroupId":{"type":"string"},"criterionId":{"type":"string"},"keywordText":{"type":"string"},"matchType":{"anyOf":[{"type":"string"},{"type":"null"}]},"campaignName":{"anyOf":[{"type":"string"},{"type":"null"}]},"adGroupName":{"anyOf":[{"type":"string"},{"type":"null"}]},"qualityScore":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"expectedCtr":{"anyOf":[{"type":"string","enum":["below_average","average","above_average"]},{"type":"null"}]},"adRelevance":{"anyOf":[{"type":"string","enum":["below_average","average","above_average"]},{"type":"null"}]},"landingPageExperience":{"anyOf":[{"type":"string","enum":["below_average","average","above_average"]},{"type":"null"}]},"impressions":{"type":"number"},"clicks":{"type":"number"},"costMicros":{"type":"number"}},"required":["searchTerm","adGroupId","criterionId","keywordText","matchType","campaignName","adGroupName","qualityScore","expectedCtr","adRelevance","landingPageExperience","impressions","clicks","costMicros"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"total":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["data","nextCursor","accountId","total"],"additionalProperties":false},"BusinessGoogleAdsDestinationsGetResponse":{"type":"object","properties":{"account":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customerId":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","customerId","name"],"additionalProperties":false},"campaigns":{"type":"array","items":{"type":"object","properties":{"campaignId":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"channelType":{"type":"string","enum":["SEARCH","DISPLAY"]}},"required":["campaignId","name","status","channelType"],"additionalProperties":false}},"adGroups":{"type":"array","items":{"type":"object","properties":{"campaignId":{"type":"string"},"adGroupId":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["campaignId","adGroupId","name","status","type"],"additionalProperties":false}}},"required":["account","campaigns","adGroups"],"additionalProperties":false},"BusinessOutcomeConnectionsGetResponse":{"type":"object","properties":{"configured":{"type":"boolean"},"sample":{"type":"boolean"},"connection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"status":{"type":"string","enum":["authorizing","active","revocation_pending","superseded","revoked"]},"connectedAt":{"type":"string"},"connectedBy":{"type":"string"}},"required":["id","status","connectedAt","connectedBy"],"additionalProperties":false},{"type":"null"}]},"sources":{"$ref":"#/components/schemas/BusinessSources"}},"required":["configured","sample","connection","sources"],"additionalProperties":false},"BusinessOutcomeConnectionsGetV2Response":{"type":"object","properties":{"configured":{"type":"boolean"},"sample":{"type":"boolean"},"connection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"status":{"type":"string","enum":["authorizing","active","revocation_pending","superseded","revoked"]},"connectedAt":{"type":"string"},"connectedBy":{"type":"string"}},"required":["id","status","connectedAt","connectedBy"],"additionalProperties":false},{"type":"null"}]},"sources":{"$ref":"#/components/schemas/BusinessSources2"}},"required":["configured","sample","connection","sources"],"additionalProperties":false},"BusinessOutcomeConnectionsListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"configured":{"type":"boolean"},"sample":{"type":"boolean"},"connection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"status":{"type":"string","enum":["authorizing","active","revocation_pending","superseded","revoked"]},"connectedAt":{"type":"string"},"connectedBy":{"type":"string"}},"required":["id","status","connectedAt","connectedBy"],"additionalProperties":false},{"type":"null"}]},"sources":{"$ref":"#/components/schemas/BusinessSources2"},"source":{"type":"string","enum":["google_analytics","vercel_web_analytics","shopify"]}},"required":["configured","sample","connection","sources","source"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"BusinessOutcomeSourcesDiscoverRequest":{"type":"object","properties":{"source":{"type":"string","enum":["google_analytics","vercel_web_analytics","shopify"]}},"required":["source"],"additionalProperties":false},"BusinessOutcomeSourcesDiscoverResponse":{"type":"object","properties":{"sources":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["sources"],"additionalProperties":false},"BusinessOutcomeSourcesSelectRequest":{"type":"object","properties":{"source":{"type":"string","enum":["google_analytics","vercel_web_analytics","shopify"]},"sources":{"maxItems":200,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["id"],"additionalProperties":false}}},"required":["source","sources"],"additionalProperties":false},"BusinessOutcomeSourcesSelectResponse":{"type":"object","properties":{"selected":{"type":"integer","minimum":0,"maximum":9007199254740991},"checkStarted":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["selected","checkStarted"],"additionalProperties":false},"BusinessOutcomeSourcesCheckRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"additionalProperties":false},"BusinessOutcomeSourcesCheckResponse":{"type":"object","properties":{"queued":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["queued"],"additionalProperties":false},"BusinessOutcomeResultsGetResponse":{"type":"object","properties":{"connections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"source":{"type":"string","enum":["google_analytics","vercel_web_analytics"]},"sample":{"type":"boolean"}},"required":["id","source","sample"],"additionalProperties":false}},"sources":{"$ref":"#/components/schemas/BusinessSources"},"traffic":{"anyOf":[{"type":"object","properties":{"source":{"$ref":"#/components/schemas/BusinessItem"},"window":{"type":"object","properties":{"from":{"type":"string"},"through":{"type":"string"}},"required":["from","through"],"additionalProperties":false},"previousWindow":{"type":"object","properties":{"from":{"type":"string"},"through":{"type":"string"}},"required":["from","through"],"additionalProperties":false},"totals":{"type":"object","properties":{"sessions":{"type":"number"},"keyEvents":{"anyOf":[{"type":"number"},{"type":"null"}]},"revenue":{"anyOf":[{"type":"number"},{"type":"null"}]},"aiSessions":{"type":"number"},"aiKeyEvents":{"anyOf":[{"type":"number"},{"type":"null"}]},"aiRevenue":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["sessions","keyEvents","revenue","aiSessions","aiKeyEvents","aiRevenue"],"additionalProperties":false},"previous":{"type":"object","properties":{"sessions":{"type":"number"},"keyEvents":{"anyOf":[{"type":"number"},{"type":"null"}]},"revenue":{"anyOf":[{"type":"number"},{"type":"null"}]},"aiSessions":{"type":"number"},"aiKeyEvents":{"anyOf":[{"type":"number"},{"type":"null"}]},"aiRevenue":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["sessions","keyEvents","revenue","aiSessions","aiKeyEvents","aiRevenue"],"additionalProperties":false},"daily":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"sessions":{"type":"number"},"aiSessions":{"type":"number"},"assistants":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"number"}}},"required":["date","sessions","aiSessions","assistants"],"additionalProperties":false}},"assistants":{"type":"array","items":{"type":"object","properties":{"slug":{"type":"string"},"label":{"type":"string"},"sessions":{"type":"number"},"keyEvents":{"anyOf":[{"type":"number"},{"type":"null"}]},"revenue":{"anyOf":[{"type":"number"},{"type":"null"}]},"previousSessions":{"type":"number"}},"required":["slug","label","sessions","keyEvents","revenue","previousSessions"],"additionalProperties":false}},"pages":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"sessions":{"type":"number"},"keyEvents":{"anyOf":[{"type":"number"},{"type":"null"}]},"revenue":{"anyOf":[{"type":"number"},{"type":"null"}]},"previousSessions":{"type":"number"}},"required":["path","sessions","keyEvents","revenue","previousSessions"],"additionalProperties":false}}},"required":["source","window","previousWindow","totals","previous","daily","assistants","pages"],"additionalProperties":false},{"type":"null"}]}},"required":["connections","sources","traffic"],"additionalProperties":false},"BusinessOutcomeResultsGetV2Response":{"type":"object","properties":{"connections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"source":{"type":"string","enum":["google_analytics","vercel_web_analytics","shopify"]},"sample":{"type":"boolean"}},"required":["id","source","sample"],"additionalProperties":false}},"sources":{"$ref":"#/components/schemas/BusinessSources2"},"traffic":{"anyOf":[{"type":"object","properties":{"source":{"$ref":"#/components/schemas/BusinessItem2"},"window":{"type":"object","properties":{"from":{"type":"string"},"through":{"type":"string"}},"required":["from","through"],"additionalProperties":false},"previousWindow":{"type":"object","properties":{"from":{"type":"string"},"through":{"type":"string"}},"required":["from","through"],"additionalProperties":false},"totals":{"type":"object","properties":{"sessions":{"type":"number"},"keyEvents":{"anyOf":[{"type":"number"},{"type":"null"}]},"revenue":{"anyOf":[{"type":"number"},{"type":"null"}]},"aiSessions":{"type":"number"},"aiKeyEvents":{"anyOf":[{"type":"number"},{"type":"null"}]},"aiRevenue":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["sessions","keyEvents","revenue","aiSessions","aiKeyEvents","aiRevenue"],"additionalProperties":false},"previous":{"type":"object","properties":{"sessions":{"type":"number"},"keyEvents":{"anyOf":[{"type":"number"},{"type":"null"}]},"revenue":{"anyOf":[{"type":"number"},{"type":"null"}]},"aiSessions":{"type":"number"},"aiKeyEvents":{"anyOf":[{"type":"number"},{"type":"null"}]},"aiRevenue":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["sessions","keyEvents","revenue","aiSessions","aiKeyEvents","aiRevenue"],"additionalProperties":false},"daily":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"sessions":{"type":"number"},"aiSessions":{"type":"number"},"assistants":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"number"}}},"required":["date","sessions","aiSessions","assistants"],"additionalProperties":false}},"assistants":{"type":"array","items":{"type":"object","properties":{"slug":{"type":"string"},"label":{"type":"string"},"sessions":{"type":"number"},"keyEvents":{"anyOf":[{"type":"number"},{"type":"null"}]},"revenue":{"anyOf":[{"type":"number"},{"type":"null"}]},"previousSessions":{"type":"number"}},"required":["slug","label","sessions","keyEvents","revenue","previousSessions"],"additionalProperties":false}},"pages":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"sessions":{"type":"number"},"keyEvents":{"anyOf":[{"type":"number"},{"type":"null"}]},"revenue":{"anyOf":[{"type":"number"},{"type":"null"}]},"previousSessions":{"type":"number"}},"required":["path","sessions","keyEvents","revenue","previousSessions"],"additionalProperties":false}}},"required":["source","window","previousWindow","totals","previous","daily","assistants","pages"],"additionalProperties":false},{"type":"null"}]}},"required":["connections","sources","traffic"],"additionalProperties":false},"BusinessOutcomePageChangesMeasureRequest":{"type":"object","properties":{"changes":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":200},"pages":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":2048}},"changedFrom":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"changedThrough":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"}},"required":["key","pages","changedFrom","changedThrough"],"additionalProperties":false}}},"required":["changes"],"additionalProperties":false,"deprecated":true},"BusinessOutcomePageChangesMeasureResponse":{"type":"object","properties":{"source":{"anyOf":[{"$ref":"#/components/schemas/BusinessItem"},{"type":"null"}]},"syncedThrough":{"anyOf":[{"type":"string"},{"type":"null"}]},"windowDays":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"minAfterDays":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"changes":{"$ref":"#/components/schemas/BusinessChanges"}},"required":["source","syncedThrough","windowDays","minAfterDays","changes"],"additionalProperties":false},"BusinessOutcomePageChangesMeasureV2Request":{"type":"object","properties":{"changes":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":200},"pages":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":2048}},"changedFrom":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"changedThrough":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"}},"required":["key","pages","changedFrom","changedThrough"],"additionalProperties":false}}},"required":["changes"],"additionalProperties":false},"BusinessOutcomePageChangesMeasureV2Response":{"type":"object","properties":{"source":{"anyOf":[{"$ref":"#/components/schemas/BusinessItem2"},{"type":"null"}]},"syncedThrough":{"anyOf":[{"type":"string"},{"type":"null"}]},"windowDays":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"minAfterDays":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"changes":{"$ref":"#/components/schemas/BusinessChanges"}},"required":["source","syncedThrough","windowDays","minAfterDays","changes"],"additionalProperties":false},"BusinessOutcomeSeriesListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"origin":{"type":"string","enum":["custom","crm_import","crm_sync"]},"name":{"type":"string"},"kind":{"type":"string","enum":["total","level"]},"unit":{"type":"string","enum":["currency","count","percent"]},"currencyCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"split":{"type":"string","enum":["none","channel"]},"definition":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"valuesUpdatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"firstDate":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastDate":{"anyOf":[{"type":"string"},{"type":"null"}]},"days":{"type":"integer","minimum":0,"maximum":9007199254740991},"crm":{"anyOf":[{"type":"object","properties":{"syncId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"measure":{"type":"string","enum":["deals","revenue"]}},"required":["syncId","measure"],"additionalProperties":false},{"type":"null"}]},"recent":{"maxItems":90,"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"value":{"type":"number"},"ai":{"anyOf":[{"type":"number"},{"type":"null"}]},"other":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["date","value","ai","other"],"additionalProperties":false}}},"required":["id","origin","name","kind","unit","currencyCode","split","definition","createdAt","valuesUpdatedAt","firstDate","lastDate","days","crm","recent"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"BusinessOutcomeSeriesCreateRequest":{"type":"object","properties":{"origin":{"default":"custom","type":"string","enum":["custom","crm_import"]},"name":{"type":"string","minLength":1,"maxLength":120},"kind":{"type":"string","enum":["total","level"]},"unit":{"type":"string","enum":["currency","count","percent"]},"currencyCode":{"default":null,"anyOf":[{"type":"string","pattern":"^[A-Z]{3}$"},{"type":"null"}]},"split":{"default":"none","type":"string","enum":["none","channel"]},"definition":{"default":null,"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]}},"required":["name","kind","unit"],"additionalProperties":false},"BusinessOutcomeSeriesCreateResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"origin":{"type":"string","enum":["custom","crm_import","crm_sync"]},"name":{"type":"string"},"kind":{"type":"string","enum":["total","level"]},"unit":{"type":"string","enum":["currency","count","percent"]},"currencyCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"split":{"type":"string","enum":["none","channel"]},"definition":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"valuesUpdatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"firstDate":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastDate":{"anyOf":[{"type":"string"},{"type":"null"}]},"days":{"type":"integer","minimum":0,"maximum":9007199254740991},"crm":{"anyOf":[{"type":"object","properties":{"syncId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"measure":{"type":"string","enum":["deals","revenue"]}},"required":["syncId","measure"],"additionalProperties":false},{"type":"null"}]}},"required":["id","origin","name","kind","unit","currencyCode","split","definition","createdAt","valuesUpdatedAt","firstDate","lastDate","days","crm"],"additionalProperties":false},"BusinessOutcomeSeriesDeleteRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["id"],"additionalProperties":false},"BusinessOutcomeSeriesDeleteResponse":{"type":"object","properties":{"deleted":{"type":"boolean","const":true}},"required":["deleted"],"additionalProperties":false},"BusinessOutcomeSeriesValuesImportRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"mode":{"default":"merge","type":"string","enum":["replace","merge"]},"days":{"minItems":1,"maxItems":1830,"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"value":{"type":"number"},"ai":{"type":"number"},"other":{"type":"number"}},"required":["date"],"additionalProperties":false}}},"required":["id","days"],"additionalProperties":false},"BusinessOutcomeSeriesValuesImportResponse":{"type":"object","properties":{"written":{"type":"integer","minimum":0,"maximum":9007199254740991},"from":{"anyOf":[{"type":"string"},{"type":"null"}]},"through":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["written","from","through"],"additionalProperties":false},"BusinessOutcomeCrmSyncsListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"provider":{"type":"string","enum":["hubspot","salesforce"]},"deals":{"type":"boolean"},"revenue":{"type":"boolean"},"createdAt":{"type":"string"},"syncedThrough":{"anyOf":[{"type":"string"},{"type":"null"}]},"attemptedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"errorCode":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","provider","deals","revenue","createdAt","syncedThrough","attemptedAt","errorCode"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"BusinessOutcomeCrmSyncsCreateRequest":{"type":"object","properties":{"provider":{"type":"string","enum":["hubspot","salesforce"]},"deals":{"default":true,"type":"boolean"},"revenue":{"default":true,"type":"boolean"}},"required":["provider"],"additionalProperties":false},"BusinessOutcomeCrmSyncsCreateResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"provider":{"type":"string","enum":["hubspot","salesforce"]},"deals":{"type":"boolean"},"revenue":{"type":"boolean"},"createdAt":{"type":"string"},"syncedThrough":{"anyOf":[{"type":"string"},{"type":"null"}]},"attemptedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"errorCode":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","provider","deals","revenue","createdAt","syncedThrough","attemptedAt","errorCode"],"additionalProperties":false},"BusinessOutcomeCrmSyncsDeleteRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["id"],"additionalProperties":false},"BusinessOutcomeCrmSyncsDeleteResponse":{"type":"object","properties":{"deleted":{"type":"boolean","const":true}},"required":["deleted"],"additionalProperties":false},"BusinessOutcomePairingChoicesGetResponse":{"type":"object","properties":{"campaigns":{"type":"array","items":{"type":"object","properties":{"product":{"type":"string","enum":["discovery","experience"]},"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["product","campaignId","name"],"additionalProperties":false}},"sources":{"type":"array","items":{"type":"object","properties":{"sourceId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"kind":{"type":"string","enum":["ga4_property","vercel_project","shopify_shop"]},"name":{"type":"string"},"currencyCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"measures":{"type":"array","items":{"type":"string","enum":["sessions","key_events","revenue"]}}},"required":["sourceId","kind","name","currencyCode","measures"],"additionalProperties":false}},"series":{"maxItems":50,"type":"array","items":{"$ref":"#/components/schemas/BusinessOutcomeSeriesCreateResponse"}}},"required":["campaigns","sources","series"],"additionalProperties":false},"BusinessOutcomePairingsListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"pinned":{"type":"boolean"},"createdAt":{"type":"string"},"signal":{"anyOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["discovery_win_rate","discovery_brand_share","experience_pass_rate"]},"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"label":{"type":"string"},"unit":{"type":"string","const":"percent"}},"required":["kind","campaignId","label","unit"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"outcome"},"outcome":{"anyOf":[{"type":"object","properties":{"sourceId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"measure":{"type":"string","enum":["sessions","key_events","revenue"]},"channel":{"type":"string","enum":["all","ai","other"]}},"required":["sourceId","measure","channel"],"additionalProperties":false},{"type":"object","properties":{"seriesId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"measure":{"type":"string","const":"value"},"channel":{"type":"string","enum":["all","ai","other"]}},"required":["seriesId","measure","channel"],"additionalProperties":false}]},"label":{"type":"string"},"unit":{"type":"string","enum":["currency","count","percent"]}},"required":["kind","outcome","label","unit"],"additionalProperties":false}]},"outcome":{"anyOf":[{"type":"object","properties":{"sourceId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"measure":{"type":"string","enum":["sessions","key_events","revenue"]},"channel":{"type":"string","enum":["all","ai","other"]},"label":{"type":"string"},"unit":{"type":"string","enum":["currency","count","percent"]},"currencyCode":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["sourceId","measure","channel","label","unit","currencyCode"],"additionalProperties":false},{"type":"object","properties":{"seriesId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"measure":{"type":"string","const":"value"},"channel":{"type":"string","enum":["all","ai","other"]},"label":{"type":"string"},"unit":{"type":"string","enum":["currency","count","percent"]},"currencyCode":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["seriesId","measure","channel","label","unit","currencyCode"],"additionalProperties":false}]},"comparison":{"anyOf":[{"type":"object","properties":{"label":{"type":"string"}},"required":["label"],"additionalProperties":false},{"type":"null"}]},"association":{"type":"object","properties":{"label":{"type":"string","enum":["collecting","inconclusive","no_meaningful_link","suggestive","consistent"]},"design":{"type":"string","enum":["observational","controlled_observational"]},"pinned":{"type":"boolean"},"weeks":{"type":"integer","minimum":0,"maximum":9007199254740991},"signalWeeks":{"type":"integer","minimum":0,"maximum":9007199254740991},"outcomeWeeks":{"type":"integer","minimum":0,"maximum":9007199254740991},"readableFrom":{"anyOf":[{"type":"string"},{"type":"null"}]},"lagWeeks":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"correlation":{"anyOf":[{"type":"object","properties":{"value":{"type":"number"},"low":{"type":"number"},"high":{"type":"number"}},"required":["value","low","high"],"additionalProperties":false},{"type":"null"}]},"effect":{"anyOf":[{"type":"object","properties":{"value":{"type":"number"},"low":{"type":"number"},"high":{"type":"number"}},"required":["value","low","high"],"additionalProperties":false},{"type":"null"}]},"pValue":{"anyOf":[{"type":"number"},{"type":"null"}]},"holdsLater":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"detectable":{"anyOf":[{"type":"number"},{"type":"null"}]},"signalReliability":{"anyOf":[{"type":"number"},{"type":"null"}]},"series":{"type":"array","items":{"type":"object","properties":{"week":{"type":"string"},"signal":{"anyOf":[{"type":"number"},{"type":"null"}]},"outcome":{"anyOf":[{"type":"number"},{"type":"null"}]},"comparison":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["week","signal","outcome","comparison"],"additionalProperties":false}},"changes":{"type":"array","items":{"type":"object","properties":{"week":{"type":"string"},"signal":{"type":"number"},"outcome":{"type":"number"}},"required":["week","signal","outcome"],"additionalProperties":false}}},"required":["label","design","pinned","weeks","signalWeeks","outcomeWeeks","readableFrom","lagWeeks","correlation","effect","pValue","holdsLater","detectable","signalReliability","series","changes"],"additionalProperties":false},"summary":{"type":"string"}},"required":["id","pinned","createdAt","signal","outcome","comparison","association","summary"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"BusinessOutcomePairingsCreateRequest":{"type":"object","properties":{"signal":{"anyOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["discovery_win_rate","discovery_brand_share","experience_pass_rate"]},"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","campaignId"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"outcome"},"outcome":{"anyOf":[{"type":"object","properties":{"sourceId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"measure":{"type":"string","enum":["sessions","key_events","revenue"]},"channel":{"type":"string","enum":["all","ai","other"]}},"required":["sourceId","measure","channel"],"additionalProperties":false},{"type":"object","properties":{"seriesId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"measure":{"type":"string","const":"value"},"channel":{"type":"string","enum":["all","ai","other"]}},"required":["seriesId","measure","channel"],"additionalProperties":false}]}},"required":["kind","outcome"],"additionalProperties":false}]},"outcome":{"anyOf":[{"type":"object","properties":{"sourceId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"measure":{"type":"string","enum":["sessions","key_events","revenue"]},"channel":{"type":"string","enum":["all","ai","other"]}},"required":["sourceId","measure","channel"],"additionalProperties":false},{"type":"object","properties":{"seriesId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"measure":{"type":"string","const":"value"},"channel":{"type":"string","enum":["all","ai","other"]}},"required":["seriesId","measure","channel"],"additionalProperties":false}]},"pinned":{"default":false,"type":"boolean"}},"required":["signal","outcome"],"additionalProperties":false},"BusinessOutcomePairingsCreateResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["id"],"additionalProperties":false},"BusinessOutcomePairingsUpdateRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"pinned":{"type":"boolean"}},"required":["id","pinned"],"additionalProperties":false},"BusinessOutcomePairingsUpdateResponse":{"type":"object","properties":{"pinned":{"type":"boolean"}},"required":["pinned"],"additionalProperties":false},"BusinessOutcomePairingsDeleteRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["id"],"additionalProperties":false},"BusinessOutcomePairingsDeleteResponse":{"type":"object","properties":{"deleted":{"type":"boolean","const":true}},"required":["deleted"],"additionalProperties":false},"BusinessCustomersListV2Response":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customerKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"type":"string"},"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"businessProfileKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"profileName":{"anyOf":[{"type":"string"},{"type":"null"}]},"profileUrl":{"type":"string"},"profileBusinessSummary":{"anyOf":[{"type":"string"},{"type":"null"}]},"source":{"type":"string","enum":["generated","manual","connected"]},"poolStatus":{"type":"string","enum":["active","retired"]},"retiredAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"forecastSeeded":{"type":"boolean"},"audiences":{"type":"array","items":{"type":"string"}},"systemAudiences":{"type":"array","items":{"type":"string"}},"userAudiences":{"type":"array","items":{"type":"string"}},"userAudienceIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"sources":{"type":"array","items":{"type":"string"}},"jobTitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"gender":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Gender"},"age":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Age"},"age.band":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Age band"},"language":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Language"},"location":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Location"},"market":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Market"},"areaType":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Area type"},"education":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Education"},"lifeStage":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Life stage"},"householdIncome":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Household income"},"householdIncome.band":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Income band"},"occupation":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Occupation"},"seniority":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Seniority"},"employer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Employer"},"companySize":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Company size"},"companySize.band":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Size band"},"annualRevenue":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Annual revenue"},"buyerType":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Buyer type"},"audience":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Audience"},"product":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Product"},"channel":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Channel"},"buyerRole":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Buyer role"},"intentStage":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Intent stage"},"job":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Job to be done"},"triggerType":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Trigger type"},"trigger":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Trigger"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"generationRunId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"latestDiscoveryOutcome":{"$ref":"#/components/schemas/DiscoveryLatestDiscoveryOutcome"}},"required":["id","customerKey","label","businessProfileId","businessProfileKey","profileName","profileUrl","profileBusinessSummary","source","poolStatus","retiredAt","forecastSeeded","audiences","systemAudiences","userAudiences","userAudienceIds","sources","jobTitle","gender","age","age.band","language","location","market","areaType","education","lifeStage","householdIncome","householdIncome.band","occupation","seniority","employer","companySize","companySize.band","annualRevenue","buyerType","audience","product","channel","buyerRole","intentStage","job","triggerType","trigger","createdAt","generationRunId","latestDiscoveryOutcome"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"totalCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"statusCounts":{"type":"object","properties":{"active":{"type":"integer","minimum":0,"maximum":9007199254740991},"archived":{"type":"integer","minimum":0,"maximum":9007199254740991},"all":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["active","archived","all"],"additionalProperties":false},"audienceFacets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"label":{"type":"string"},"count":{"type":"integer","minimum":0,"maximum":9007199254740991},"kind":{"type":"string","enum":["source","system-audience","user-audience"]}},"required":["id","name","label","count","kind"],"additionalProperties":false}},"audienceFacetTotal":{"type":"integer","minimum":0,"maximum":9007199254740991},"generation":{"anyOf":[{"type":"object","properties":{"state":{"type":"string","enum":["generating","failed","cancelled"]},"targetCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["state","targetCount"],"additionalProperties":false},{"type":"null"}]},"interviewEligibleCustomerIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"audienceTypes":{"type":"array","items":{"type":"string","enum":["b2b","b2c","prosumer","mixed"]},"description":"The audience types of the customers this list draws from, each read as a Buyer type (b2c is B2C; b2b, prosumer and mixed are B2B); a column only another Buyer type carries is not a column."},"edits":{"$ref":"#/components/schemas/BusinessEdits"}},"required":["data","nextCursor","totalCount","statusCounts","audienceFacets","audienceFacetTotal","generation","interviewEligibleCustomerIds","audienceTypes"],"additionalProperties":false},"BusinessCustomersListV3Response":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customerKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"type":"string"},"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"businessProfileKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"profileName":{"anyOf":[{"type":"string"},{"type":"null"}]},"profileUrl":{"type":"string"},"profileBusinessSummary":{"anyOf":[{"type":"string"},{"type":"null"}]},"source":{"type":"string","enum":["generated","manual","connected"]},"poolStatus":{"type":"string","enum":["active","retired"]},"retiredAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"forecastSeeded":{"type":"boolean"},"audiences":{"type":"array","items":{"type":"string"}},"systemAudiences":{"type":"array","items":{"type":"string"}},"userAudiences":{"type":"array","items":{"type":"string"}},"userAudienceIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"sources":{"type":"array","items":{"type":"string"}},"jobTitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"gender":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Gender"},"age":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Age"},"age.band":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Age band"},"language":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Language"},"location":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Location"},"market":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Market"},"areaType":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Area type"},"education":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Education"},"lifeStage":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Life stage"},"householdIncome":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Household income"},"householdIncome.band":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Income band"},"occupation":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Occupation"},"seniority":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Seniority"},"employer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Employer"},"companySize":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Company size"},"companySize.band":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Size band"},"annualRevenue":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Annual revenue"},"buyerType":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Buyer type"},"audience":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Audience"},"product":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Product"},"channel":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Channel"},"buyerRole":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Buyer role"},"intentStage":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Intent stage"},"job":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Job to be done"},"triggerType":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Trigger type"},"trigger":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Trigger"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"generationRunId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"latestDiscoveryOutcome":{"$ref":"#/components/schemas/DiscoveryItemLatestDiscoveryOutcome"}},"required":["id","customerKey","label","businessProfileId","businessProfileKey","profileName","profileUrl","profileBusinessSummary","source","poolStatus","retiredAt","forecastSeeded","audiences","systemAudiences","userAudiences","userAudienceIds","sources","jobTitle","gender","age","age.band","language","location","market","areaType","education","lifeStage","householdIncome","householdIncome.band","occupation","seniority","employer","companySize","companySize.band","annualRevenue","buyerType","audience","product","channel","buyerRole","intentStage","job","triggerType","trigger","createdAt","generationRunId","latestDiscoveryOutcome"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"totalCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"statusCounts":{"type":"object","properties":{"active":{"type":"integer","minimum":0,"maximum":9007199254740991},"archived":{"type":"integer","minimum":0,"maximum":9007199254740991},"all":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["active","archived","all"],"additionalProperties":false},"audienceFacets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"label":{"type":"string"},"count":{"type":"integer","minimum":0,"maximum":9007199254740991},"kind":{"type":"string","enum":["source","system-audience","user-audience"]}},"required":["id","name","label","count","kind"],"additionalProperties":false}},"audienceFacetTotal":{"type":"integer","minimum":0,"maximum":9007199254740991},"generation":{"anyOf":[{"type":"object","properties":{"state":{"type":"string","enum":["generating","failed","cancelled"]},"targetCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["state","targetCount"],"additionalProperties":false},{"type":"null"}]},"interviewEligibleCustomerIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"audienceTypes":{"type":"array","items":{"type":"string","enum":["b2b","b2c","prosumer","mixed"]},"description":"The audience types of the customers this list draws from, each read as a Buyer type (b2c is B2C; b2b, prosumer and mixed are B2B); a column only another Buyer type carries is not a column."},"edits":{"$ref":"#/components/schemas/BusinessEdits"}},"required":["data","nextCursor","totalCount","statusCounts","audienceFacets","audienceFacetTotal","generation","interviewEligibleCustomerIds","audienceTypes"],"additionalProperties":false},"BusinessCustomerPoolSelectionsListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"poolStatus":{"type":"string","enum":["active","retired"]},"source":{"type":"string","enum":["generated","manual","connected"]}},"required":["id","poolStatus","source"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"BusinessCustomerModelFactsListResponse":{"type":"object","properties":{"data":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"The customer's current version, which the facts state"},"facts":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/__schema0"},"description":"The customer model's attributes by key, as Point11's models read them: a category and a band by label, never an id"}},"required":["id","version","facts"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"BusinessCustomersGetV3Response":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customerKey":{"type":"string"},"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"brandProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"businessProfileKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"profileLabel":{"type":"string"},"hasOtherProfileCustomers":{"type":"boolean"},"storeProfile":{"anyOf":[{"type":"object","properties":{"locationKey":{"type":"string"},"label":{"type":"string"},"locality":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["locationKey","label","locality"],"additionalProperties":false},{"type":"null"}]},"profileStoreCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"generationProfileId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"generatedByRunId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"source":{"type":"string","enum":["generated","manual","connected"]},"poolStatus":{"type":"string","enum":["active","retired"]},"retiredAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"currentVersion":{"type":"object","properties":{"customerVersionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["customerVersionId","version"],"additionalProperties":false},"audiences":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"kind":{"type":"string","enum":["source","system-audience","user-audience"]}},"required":["id","name","kind"],"additionalProperties":false}},"interviewEligible":{"type":"boolean"},"campaignName":{"type":"string"},"activity":{"type":"object","properties":{"discovery":{"type":"boolean"},"experience":{"type":"boolean"},"research":{"type":"boolean"}},"required":["discovery","experience","research"],"additionalProperties":false},"latestActivity":{"anyOf":[{"oneOf":[{"type":"object","properties":{"product":{"type":"string","const":"discovery"},"id":{"type":"string"},"campaignId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"occurredAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"outcome":{"$ref":"#/components/schemas/DiscoveryLatestDiscoveryOutcome"}},"required":["product","id","campaignId","occurredAt","outcome"],"additionalProperties":false},{"$ref":"#/components/schemas/BusinessLatestActivity"}]},{"type":"null"}]},"latestDiscoveryResult":{"anyOf":[{"type":"string","enum":["won","lost"]},{"type":"null"}]},"persona":{"$ref":"#/components/schemas/BusinessPersona"},"editable":{"$ref":"#/components/schemas/BusinessEditable"},"pins":{"$ref":"#/components/schemas/BusinessPins"},"bucketOptions":{"$ref":"#/components/schemas/BusinessBucketOptions"}},"required":["id","customerKey","businessProfileId","brandProfileId","businessProfileKey","profileLabel","hasOtherProfileCustomers","storeProfile","profileStoreCount","generationProfileId","generatedByRunId","source","poolStatus","retiredAt","createdAt","updatedAt","currentVersion","audiences","interviewEligible","campaignName","activity","latestActivity","latestDiscoveryResult","persona","editable","pins","bucketOptions"],"additionalProperties":false},"BusinessCustomersGetV4Response":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customerKey":{"type":"string"},"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"brandProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"businessProfileKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"profileLabel":{"type":"string"},"hasOtherProfileCustomers":{"type":"boolean"},"storeProfile":{"anyOf":[{"type":"object","properties":{"locationKey":{"type":"string"},"label":{"type":"string"},"locality":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["locationKey","label","locality"],"additionalProperties":false},{"type":"null"}]},"profileStoreCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"generationProfileId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"generatedByRunId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"source":{"type":"string","enum":["generated","manual","connected"]},"poolStatus":{"type":"string","enum":["active","retired"]},"retiredAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"currentVersion":{"type":"object","properties":{"customerVersionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["customerVersionId","version"],"additionalProperties":false},"audiences":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"kind":{"type":"string","enum":["source","system-audience","user-audience"]}},"required":["id","name","kind"],"additionalProperties":false}},"interviewEligible":{"type":"boolean"},"campaignName":{"type":"string"},"activity":{"type":"object","properties":{"discovery":{"type":"boolean"},"experience":{"type":"boolean"},"research":{"type":"boolean"}},"required":["discovery","experience","research"],"additionalProperties":false},"latestActivity":{"anyOf":[{"oneOf":[{"type":"object","properties":{"product":{"type":"string","const":"discovery"},"id":{"type":"string"},"campaignId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"occurredAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"outcome":{"$ref":"#/components/schemas/DiscoveryItemLatestDiscoveryOutcome"}},"required":["product","id","campaignId","occurredAt","outcome"],"additionalProperties":false},{"$ref":"#/components/schemas/BusinessLatestActivity"}]},{"type":"null"}]},"latestDiscoveryResult":{"anyOf":[{"type":"string","enum":["won","lost"]},{"type":"null"}]},"persona":{"$ref":"#/components/schemas/BusinessPersona"},"editable":{"$ref":"#/components/schemas/BusinessEditable"},"pins":{"$ref":"#/components/schemas/BusinessPins"},"bucketOptions":{"$ref":"#/components/schemas/BusinessBucketOptions"}},"required":["id","customerKey","businessProfileId","brandProfileId","businessProfileKey","profileLabel","hasOtherProfileCustomers","storeProfile","profileStoreCount","generationProfileId","generatedByRunId","source","poolStatus","retiredAt","createdAt","updatedAt","currentVersion","audiences","interviewEligible","campaignName","activity","latestActivity","latestDiscoveryResult","persona","editable","pins","bucketOptions"],"additionalProperties":false},"BusinessCustomerSelectionsGetResponse":{"type":"object","properties":{"selected":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customerKey":{"type":"string"},"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["id","customerKey","businessProfileId"],"additionalProperties":false},{"type":"null"}]},"profiles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"profileKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"type":"string"}},"required":["id","profileKey","name"],"additionalProperties":false}}},"required":["selected","profiles"],"additionalProperties":false},"BusinessCustomersUpdateV4Request":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The customer's id"},"expectedVersion":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"The customer version you read (currentVersion.version)"},"values":{"type":"object","properties":{"name":{"anyOf":[{"type":"string","maxLength":160},{"type":"null"}]},"gender":{"anyOf":[{"type":"string","pattern":"^(?:|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$"},{"type":"null"}]},"age":{"type":"object","properties":{"value":{"anyOf":[{"type":"string"},{"type":"null"}]},"band":{"anyOf":[{"type":"string","pattern":"^(?:|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$"},{"type":"null"}]}},"additionalProperties":false},"language":{"anyOf":[{"type":"string","pattern":"^(?:|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$"},{"type":"null"}]},"location":{"anyOf":[{"type":"object","properties":{"countryCode":{"anyOf":[{"type":"string","pattern":"^[A-Z]{2}$"},{"type":"null"}]},"subdivisionCode":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"locality":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"postalCode":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]},"country":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"subdivision":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},"required":["countryCode","subdivisionCode","locality","postalCode","country","subdivision"],"additionalProperties":false},{"type":"null"}]},"market":{"anyOf":[{"type":"string","pattern":"^(?:|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$"},{"type":"null"}]},"areaType":{"anyOf":[{"type":"string","pattern":"^(?:|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$"},{"type":"null"}]},"education":{"anyOf":[{"type":"string","pattern":"^(?:|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$"},{"type":"null"}]},"lifeStage":{"anyOf":[{"type":"string","pattern":"^(?:|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$"},{"type":"null"}]},"household":{"anyOf":[{"type":"object","properties":{"adults":{"anyOf":[{"type":"integer","minimum":0,"maximum":99},{"type":"null"}]},"children":{"anyOf":[{"type":"integer","minimum":0,"maximum":99},{"type":"null"}]},"pets":{"anyOf":[{"type":"integer","minimum":0,"maximum":99},{"type":"null"}]}},"required":["adults","children","pets"],"additionalProperties":false},{"type":"null"}]},"householdIncome":{"type":"object","properties":{"value":{"anyOf":[{"type":"string"},{"type":"null"}]},"band":{"anyOf":[{"type":"string","pattern":"^(?:|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$"},{"type":"null"}]}},"additionalProperties":false},"jobTitle":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"occupation":{"anyOf":[{"type":"string","pattern":"^(?:|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$"},{"type":"null"}]},"seniority":{"anyOf":[{"type":"string","pattern":"^(?:|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$"},{"type":"null"}]},"employer":{"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}]},"yearsInRole":{"anyOf":[{"type":"string"},{"type":"null"}]},"companySize":{"type":"object","properties":{"value":{"anyOf":[{"type":"string"},{"type":"null"}]},"band":{"anyOf":[{"type":"string","pattern":"^(?:|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$"},{"type":"null"}]}},"additionalProperties":false},"annualRevenue":{"anyOf":[{"type":"string"},{"type":"null"}]},"audience":{"anyOf":[{"type":"string","pattern":"^(?:|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$"},{"type":"null"}]},"product":{"anyOf":[{"type":"string","pattern":"^(?:|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$"},{"type":"null"}]},"channel":{"anyOf":[{"type":"string","pattern":"^(?:|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$"},{"type":"null"}]},"buyerRole":{"anyOf":[{"type":"string","pattern":"^(?:|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$"},{"type":"null"}]},"stakeholders":{"anyOf":[{"type":"string","maxLength":4000},{"type":"null"}]},"intentStage":{"anyOf":[{"type":"string","pattern":"^(?:|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$"},{"type":"null"}]},"budget":{"anyOf":[{"type":"string","maxLength":4000},{"type":"null"}]},"constraints":{"anyOf":[{"type":"string","maxLength":4000},{"type":"null"}]},"job":{"anyOf":[{"type":"string","pattern":"^(?:|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$"},{"type":"null"}]},"situation":{"anyOf":[{"type":"string","maxLength":4000},{"type":"null"}]},"triggerType":{"anyOf":[{"type":"string","pattern":"^(?:|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$"},{"type":"null"}]},"trigger":{"anyOf":[{"type":"string","maxLength":4000},{"type":"null"}]},"functionalNeed":{"anyOf":[{"type":"string","maxLength":4000},{"type":"null"}]},"emotionalNeed":{"anyOf":[{"type":"string","maxLength":4000},{"type":"null"}]},"socialNeed":{"anyOf":[{"type":"string","maxLength":4000},{"type":"null"}]},"desiredOutcome":{"anyOf":[{"type":"string","maxLength":4000},{"type":"null"}]}},"additionalProperties":false,"description":"Only the fields to change, by the customer model's keys; an empty string or null clears a field. A category takes one id from its options in business_customers_get_v4. Age, household income and company size take { value, band }: a changed value also sets its band unless the same edit sets the band. Household takes { adults, children, pets }."},"newValues":{"description":"An open category (occupation, audience, channel, market, buyerRole, job, triggerType) stated in words: the option with that label, else a new value added for this customer's business profile. A field named here is not also in values.","type":"object","properties":{"market":{"type":"string","minLength":1,"maxLength":200},"occupation":{"type":"string","minLength":1,"maxLength":200},"audience":{"type":"string","minLength":1,"maxLength":200},"product":{"type":"string","minLength":1,"maxLength":200},"channel":{"type":"string","minLength":1,"maxLength":200},"buyerRole":{"type":"string","minLength":1,"maxLength":200},"job":{"type":"string","minLength":1,"maxLength":200},"triggerType":{"type":"string","minLength":1,"maxLength":200}},"additionalProperties":false}},"required":["id","expectedVersion","values"],"additionalProperties":false},"BusinessCustomersUpdateV4Response":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customerVersionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"pinnedFields":{"type":"array","items":{"type":"string","enum":["name","gender","age","language","location","market","areaType","education","lifeStage","household","householdIncome","jobTitle","occupation","seniority","employer","yearsInRole","companySize","annualRevenue","audience","product","channel","buyerRole","stakeholders","intentStage","budget","constraints","job","situation","triggerType","trigger","functionalNeed","emotionalNeed","socialNeed","desiredOutcome"]}},"derivedFields":{"type":"array","items":{"type":"string","enum":["name","gender","age","age.band","language","location","market","areaType","education","lifeStage","household","householdIncome","householdIncome.band","jobTitle","occupation","seniority","employer","yearsInRole","companySize","companySize.band","annualRevenue","audience","product","channel","buyerRole","stakeholders","intentStage","budget","constraints","job","situation","triggerType","trigger","functionalNeed","emotionalNeed","socialNeed","desiredOutcome"]},"description":"Fields set by rule rather than by the edit: a band computed from its changed value, a business customer's company size and annual revenue cleared with a changed employer (its situation stays), and each attribute the customer's new buyer type does not have cleared with a changed audience"},"newValues":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["market","occupation","audience","product","channel","buyerRole","job","triggerType"]},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"label":{"type":"string"},"created":{"type":"boolean","description":"This edit added the value; false when an option already had that label"}},"required":["field","id","label","created"],"additionalProperties":false},"description":"The option each of the edit's newValues set"},"place":{"anyOf":[{"oneOf":[{"type":"object","properties":{"outcome":{"type":"string","const":"placed"},"subdivisionCode":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["outcome","subdivisionCode"],"additionalProperties":false},{"type":"object","properties":{"outcome":{"type":"string","const":"unresolved"},"reason":{"type":"string"}},"required":["outcome","reason"],"additionalProperties":false},{"type":"object","properties":{"outcome":{"type":"string","const":"unchecked"}},"required":["outcome"],"additionalProperties":false}]},{"type":"null"}],"description":"The changed place's Mapbox check: placed (its ISO subdivision code and coordinates were set), unresolved (the place is kept as written, without coordinates) or unchecked (nothing finer than a country); null when the place did not change"},"rerun":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The edit's rerun request; list its reruns with campaigns_member_reruns_list_v1"},"joinedRequestIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":"Earlier edits' rerun requests this edit joined: a customer whose rerun an earlier edit asked for has not started yet reruns once, on its newest version, and that rerun is listed under the earlier request, not requestId"},"customers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Customers that rerun"},"campaigns":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Campaigns they rerun in"},"skipped":{"$ref":"#/components/schemas/BusinessSkipped"}},"required":["requestId","joinedRequestIds","customers","campaigns","skipped"],"additionalProperties":false,"description":"The edit's rerun of the customer in its live campaigns"}},"required":["id","customerVersionId","version","pinnedFields","derivedFields","newValues","place","rerun"],"additionalProperties":false},"BusinessCustomersArchiveRequest":{"type":"object","properties":{"customerIds":{"minItems":1,"maxItems":1000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":"The customers' ids (1–1000)"}},"required":["customerIds"],"additionalProperties":false},"BusinessCustomersArchiveResponse":{"type":"object","properties":{"command":{"type":"string","enum":["archive","restore","delete"]},"changedCustomers":{"type":"integer","minimum":0,"maximum":9007199254740991},"removedFutureMemberships":{"type":"object","properties":{"discovery":{"type":"integer","minimum":0,"maximum":9007199254740991},"research":{"type":"integer","minimum":0,"maximum":9007199254740991},"experience":{"type":"integer","minimum":0,"maximum":9007199254740991},"total":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["discovery","research","experience","total"],"additionalProperties":false},"impact":{"$ref":"#/components/schemas/BusinessImpact"}},"required":["command","changedCustomers","removedFutureMemberships","impact"],"additionalProperties":false},"BusinessCustomersRestoreRequest":{"type":"object","properties":{"customerIds":{"minItems":1,"maxItems":1000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":"The customers' ids (1–1000)"}},"required":["customerIds"],"additionalProperties":false},"BusinessCustomersRestoreResponse":{"type":"object","properties":{"command":{"type":"string","enum":["archive","restore","delete"]},"changedCustomers":{"type":"integer","minimum":0,"maximum":9007199254740991},"removedFutureMemberships":{"type":"object","properties":{"discovery":{"type":"integer","minimum":0,"maximum":9007199254740991},"research":{"type":"integer","minimum":0,"maximum":9007199254740991},"experience":{"type":"integer","minimum":0,"maximum":9007199254740991},"total":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["discovery","research","experience","total"],"additionalProperties":false},"impact":{"$ref":"#/components/schemas/BusinessImpact"}},"required":["command","changedCustomers","removedFutureMemberships","impact"],"additionalProperties":false},"BusinessCustomersDeleteRequest":{"type":"object","properties":{"customerIds":{"minItems":1,"maxItems":1000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":"The customers' ids (1–1000)"}},"required":["customerIds"],"additionalProperties":false},"BusinessCustomersDeleteResponse":{"type":"object","properties":{"command":{"type":"string","enum":["archive","restore","delete"]},"changedCustomers":{"type":"integer","minimum":0,"maximum":9007199254740991},"removedFutureMemberships":{"type":"object","properties":{"discovery":{"type":"integer","minimum":0,"maximum":9007199254740991},"research":{"type":"integer","minimum":0,"maximum":9007199254740991},"experience":{"type":"integer","minimum":0,"maximum":9007199254740991},"total":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["discovery","research","experience","total"],"additionalProperties":false},"impact":{"$ref":"#/components/schemas/BusinessImpact"}},"required":["command","changedCustomers","removedFutureMemberships","impact"],"additionalProperties":false},"BusinessCustomersGenerateRequest":{"type":"object","properties":{"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"targetCount":{"type":"integer","minimum":1,"maximum":5000,"description":"Customers to generate (1–5000)"},"source":{"default":"artifact","description":"current generates from the profile's current version; artifact from generationProfileId; rows makes one customer per row in rows, keeping what each row states","type":"string","enum":["current","artifact","rows"]},"rows":{"description":"With source rows: one customer each, by the customer model's keys (business_customer_attributes_get); a category in words, a code-owned one by its id. targetCount equals the row count.","minItems":1,"maxItems":5000,"type":"array","items":{"type":"object","properties":{"gender":{"type":"string"},"age":{"type":"object","properties":{"value":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"band":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["value","band"],"additionalProperties":false},"language":{"type":"string"},"location":{"type":"object","properties":{"countryCode":{"type":"string","pattern":"^[A-Z]{2}$"},"subdivisionCode":{"anyOf":[{"type":"string","pattern":"^[A-Z]{2}-[A-Z0-9]{1,3}$"},{"type":"null"}]},"locality":{"anyOf":[{"type":"string","minLength":1,"maxLength":160},{"type":"null"}]},"postalCode":{"anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},"required":["countryCode","subdivisionCode"],"additionalProperties":false},"market":{"type":"string","minLength":1,"maxLength":80},"areaType":{"type":"string"},"education":{"type":"string"},"lifeStage":{"type":"string"},"household":{"anyOf":[{"type":"object","properties":{"adults":{"anyOf":[{"type":"integer","minimum":0,"maximum":99},{"type":"null"}]},"children":{"anyOf":[{"type":"integer","minimum":0,"maximum":99},{"type":"null"}]},"pets":{"anyOf":[{"type":"integer","minimum":0,"maximum":99},{"type":"null"}]}},"required":["adults","children","pets"],"additionalProperties":false},{"type":"object","properties":{"statement":{"type":"string","minLength":1,"maxLength":1000}},"required":["statement"],"additionalProperties":false}]},"householdIncome":{"type":"object","properties":{"value":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"band":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["value","band"],"additionalProperties":false},"jobTitle":{"type":"string","minLength":1,"maxLength":160},"occupation":{"type":"string","minLength":1,"maxLength":80},"seniority":{"type":"string"},"employer":{"type":"string","minLength":1,"maxLength":160},"yearsInRole":{"type":"object","properties":{"value":{"type":"number","minimum":0}},"required":["value"],"additionalProperties":false},"companySize":{"type":"object","properties":{"value":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"band":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["value","band"],"additionalProperties":false},"annualRevenue":{"type":"object","properties":{"value":{"type":"number","minimum":0}},"required":["value"],"additionalProperties":false},"audience":{"type":"string","minLength":1,"maxLength":80},"product":{"type":"string","minLength":1,"maxLength":80},"channel":{"type":"string","minLength":1,"maxLength":80},"buyerRole":{"type":"string","minLength":1,"maxLength":80},"stakeholders":{"type":"string","minLength":1,"maxLength":1000},"intentStage":{"type":"string"},"budget":{"type":"string","minLength":1,"maxLength":1000},"constraints":{"type":"string","minLength":1,"maxLength":1000},"job":{"type":"string","minLength":1,"maxLength":80},"situation":{"type":"string","minLength":1,"maxLength":1000},"triggerType":{"type":"string","minLength":1,"maxLength":80},"trigger":{"type":"string","minLength":1,"maxLength":1000},"functionalNeed":{"type":"string","minLength":1,"maxLength":1000},"emotionalNeed":{"type":"string","minLength":1,"maxLength":1000},"socialNeed":{"type":"string","minLength":1,"maxLength":1000},"desiredOutcome":{"type":"string","minLength":1,"maxLength":1000},"labels":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"string","minLength":1,"maxLength":120}},"account":{"type":"object","properties":{"domain":{"type":"string","pattern":"^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?[.])+([a-z]{2,63}|xn--[a-z0-9-]{1,59})$"}},"required":["domain"],"additionalProperties":false}},"additionalProperties":false}},"generationProfileId":{"description":"The generation profile (a forecast, CRM import, or Manual Profile) to use","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"assignGroupIds":{"description":"Existing audiences the new customers join; not with groupName","maxItems":10,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"groupName":{"description":"A new audience the new customers join; not with assignGroupIds","type":"string","minLength":1,"maxLength":120},"crmSeedSelection":{"description":"A CRM import's segment and buyer roles (business_crm_seed_options_get)","type":"object","properties":{"tier":{"anyOf":[{"type":"string","minLength":1,"maxLength":80},{"type":"null"}]},"buyerRoleMixIds":{"maxItems":3,"type":"array","items":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"}},"includeUndelivered":{"type":"boolean"}},"required":["tier","buyerRoleMixIds","includeUndelivered"],"additionalProperties":false}},"required":["businessProfileId","targetCount"],"additionalProperties":false},"BusinessCustomersGenerateResponse":{"type":"object","properties":{"runId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"targetCount":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"groupName":{"anyOf":[{"type":"string"},{"type":"null"}]},"customerRunId":{"description":"With source rows, the Customer run that makes the customers","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["runId","businessProfileId","targetCount","groupName"],"additionalProperties":false},"BusinessCustomerFieldPinsDeleteV2Request":{"type":"object","properties":{"customerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"pinIds":{"minItems":1,"maxItems":34,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":"The pins to release (the customer's pins[].id)"}},"required":["customerId","pinIds"],"additionalProperties":false},"BusinessCustomerFieldPinsDeleteV2Response":{"type":"object","properties":{"released":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["released"],"additionalProperties":false},"BusinessCustomerPinReviewsResolveRequest":{"type":"object","properties":{"customerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"pinId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"reviewRefreshId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The open review's refreshId"},"expectedVersion":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"The customer version you read (currentVersion.version)"},"decision":{"type":"string","enum":["keep_mine","use_crm"]}},"required":["customerId","pinId","reviewRefreshId","expectedVersion","decision"],"additionalProperties":false},"BusinessCustomerPinReviewsResolveResponse":{"type":"object","properties":{"customerVersionId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["customerVersionId"],"additionalProperties":false},"BusinessCustomerLifecycleImpactsGetResponse":{"type":"object","properties":{"impact":{"$ref":"#/components/schemas/BusinessImpact"},"blockedReason":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["impact","blockedReason"],"additionalProperties":false},"BusinessCustomerVersionsListV3Response":{"type":"object","properties":{"data":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"customerVersionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"createdAt":{"type":"string"},"origin":{"type":"string","enum":["generation_publication","source_sync","user_edit","system_edit","legacy_backfill","predecessor_bridge"]},"label":{"type":"string"},"erased":{"type":"boolean"},"actor":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"user"},"userId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["kind","userId","name"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"system"}},"required":["kind"],"additionalProperties":false}]},"source":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"crm_follow"},"provider":{"type":"string","enum":["hubspot","salesforce"]}},"required":["kind","provider"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"crm_refresh"},"provider":{"type":"string","enum":["hubspot","salesforce"]},"refreshId":{"type":"string"},"requestKey":{"type":"string"},"trigger":{"anyOf":[{"type":"string","enum":["follow","change","on_demand","rebuild"]},{"type":"null"}]},"evidenceAdded":{"type":"array","items":{"type":"object","properties":{"revisionId":{"type":"string"},"kind":{"type":"string","enum":["call","meeting"]},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"occurredAt":{"type":"string"},"sourceUrl":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["revisionId","kind","title","occurredAt","sourceUrl"],"additionalProperties":false}},"evidenceRemoved":{"type":"array","items":{"type":"object","properties":{"revisionId":{"type":"string"},"kind":{"type":"string","enum":["call","meeting"]},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"occurredAt":{"type":"string"},"sourceUrl":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["revisionId","kind","title","occurredAt","sourceUrl"],"additionalProperties":false}},"keptPinned":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["name","gender","age","age.band","language","location","market","areaType","education","lifeStage","household","householdIncome","householdIncome.band","jobTitle","occupation","seniority","employer","yearsInRole","companySize","companySize.band","annualRevenue","audience","product","channel","buyerRole","stakeholders","intentStage","budget","constraints","job","situation","triggerType","trigger","functionalNeed","emotionalNeed","socialNeed","desiredOutcome"]},"proposedFrom":{"type":"string","enum":["crm","author"]}},"required":["field","proposedFrom"],"additionalProperties":false}}},"required":["kind","provider","refreshId","requestKey","trigger","evidenceAdded","evidenceRemoved","keptPinned"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"human_edit"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"other"}},"required":["kind"],"additionalProperties":false}]},"changes":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["name","gender","age","age.band","language","location","market","areaType","education","lifeStage","household","householdIncome","householdIncome.band","jobTitle","occupation","seniority","employer","yearsInRole","companySize","companySize.band","annualRevenue","audience","product","channel","buyerRole","stakeholders","intentStage","budget","constraints","job","situation","triggerType","trigger","functionalNeed","emotionalNeed","socialNeed","desiredOutcome"]},"before":{"anyOf":[{"type":"string"},{"type":"null"}]},"after":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["field","before","after"],"additionalProperties":false}},"pins":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["name","gender","age","age.band","language","location","market","areaType","education","lifeStage","household","householdIncome","householdIncome.band","jobTitle","occupation","seniority","employer","yearsInRole","companySize","companySize.band","annualRevenue","audience","product","channel","buyerRole","stakeholders","intentStage","budget","constraints","job","situation","triggerType","trigger","functionalNeed","emotionalNeed","socialNeed","desiredOutcome"]},"event":{"type":"string","enum":["pinned","unpinned","review_raised","review_resolved"]},"at":{"type":"string"}},"required":["field","event","at"],"additionalProperties":false}}},"required":["customerVersionId","version","createdAt","origin","label","erased","actor","source","changes","pins"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"BusinessCustomerExplorerReportsGetResponse":{"type":"object","properties":{"model":{"$ref":"#/components/schemas/BusinessModel"},"baseline":{"anyOf":[{"$ref":"#/components/schemas/BusinessModel"},{"type":"null"}]}},"required":["model","baseline"],"additionalProperties":false},"BusinessCustomerConversationsListResponse":{"type":"object","properties":{"data":{"maxItems":25,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"campaignName":{"type":"string"},"engine":{"type":"string"},"engineId":{"type":"string"},"occurredAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["id","campaignId","campaignName","engine","engineId","occurredAt"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"totalCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["data","nextCursor","totalCount"],"additionalProperties":false},"BusinessCustomerConversationsGetResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"campaignId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"campaignName":{"type":"string"},"engine":{"type":"string"},"engineId":{"type":"string"},"occurredAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"scoring":{"$ref":"#/components/schemas/BusinessScoring"},"outcomeSummary":{"anyOf":[{"type":"object","properties":{"headline":{"type":"string"},"outcome":{"type":"string","enum":["Recommended","Mentioned","Not mentioned"]},"brandMentions":{"$ref":"#/components/schemas/BusinessBrandMentions"},"winningBrand":{"anyOf":[{"type":"string"},{"type":"null"}]},"targetBrand":{"anyOf":[{"type":"string"},{"type":"null"}]},"targetPosition":{"anyOf":[{"type":"number"},{"type":"null"}]},"targetSentiment":{"anyOf":[{"type":"string","enum":["positive","neutral","mixed","negative"]},{"type":"null"}]},"conversationSentiment":{"anyOf":[{"type":"string","enum":["positive","neutral","mixed","negative"]},{"type":"null"}]},"primaryDecisionFactor":{"anyOf":[{"type":"string"},{"type":"null"}]},"rationale":{"anyOf":[{"type":"string"},{"type":"null"}]},"winReasons":{"type":"array","items":{"type":"string"}},"lossReasons":{"type":"array","items":{"type":"string"}},"brandCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"citationCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"mostImportantCitation":{"$ref":"#/components/schemas/BusinessMostImportantCitation"},"positiveSentiment":{"$ref":"#/components/schemas/BusinessPositiveSentiment"},"negativeSentiment":{"$ref":"#/components/schemas/BusinessPositiveSentiment"}},"required":["headline","outcome","brandMentions","winningBrand","targetBrand","targetPosition","targetSentiment","conversationSentiment","primaryDecisionFactor","rationale","winReasons","lossReasons","brandCount","citationCount","mostImportantCitation","positiveSentiment","negativeSentiment"],"additionalProperties":false},{"type":"null"}]},"turns":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string","enum":["user","assistant"]},"body":{"type":"string"},"at":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"type":"string"},"sources":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"siteName":{"anyOf":[{"type":"string"},{"type":"null"}]},"faviconUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"faviconLightUrl":{"description":"Never sent: a source's favicon is one image for both themes, faviconUrl.","type":"null"},"faviconDarkUrl":{"description":"Never sent: a source's favicon is one image for both themes, faviconUrl.","type":"null"},"faviconTone":{"anyOf":[{"type":"string","enum":["dark","light","mixed","unknown"]},{"type":"null"}]},"faviconTransparent":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"faviconNeedsLightBackplate":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"faviconNeedsDarkBackplate":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["url"],"additionalProperties":false}},"searchQueries":{"type":"array","items":{"type":"string"}}},"required":["id","role","body"],"additionalProperties":false}}},"required":["id","campaignId","campaignName","engine","engineId","occurredAt","scoring","outcomeSummary","turns"],"additionalProperties":false},"BusinessCustomerConversationsGetV2Response":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"campaignId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"campaignName":{"type":"string"},"engine":{"type":"string"},"engineId":{"type":"string"},"occurredAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"scoring":{"$ref":"#/components/schemas/BusinessScoring"},"outcomeSummary":{"anyOf":[{"type":"object","properties":{"headline":{"type":"string"},"outcome":{"type":"string","enum":["Recommended","Mentioned","Not mentioned"]},"brandMentions":{"$ref":"#/components/schemas/BusinessBrandMentions"},"winningBrand":{"anyOf":[{"type":"string"},{"type":"null"}]},"targetBrand":{"anyOf":[{"type":"string"},{"type":"null"}]},"targetPosition":{"anyOf":[{"type":"number"},{"type":"null"}]},"targetSentiment":{"anyOf":[{"type":"string","enum":["positive","neutral","mixed","negative"]},{"type":"null"}]},"conversationSentiment":{"anyOf":[{"type":"string","enum":["positive","neutral","mixed","negative"]},{"type":"null"}]},"primaryDecisionFactor":{"anyOf":[{"type":"string"},{"type":"null"}]},"rationale":{"anyOf":[{"type":"string"},{"type":"null"}]},"winReasons":{"type":"array","items":{"type":"string"}},"lossReasons":{"type":"array","items":{"type":"string"}},"brandCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"citationCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"mostImportantCitation":{"$ref":"#/components/schemas/BusinessMostImportantCitation"},"positiveSentiment":{"$ref":"#/components/schemas/BusinessOutcomeSummaryPositiveSentiment"},"negativeSentiment":{"$ref":"#/components/schemas/BusinessOutcomeSummaryPositiveSentiment"}},"required":["headline","outcome","brandMentions","winningBrand","targetBrand","targetPosition","targetSentiment","conversationSentiment","primaryDecisionFactor","rationale","winReasons","lossReasons","brandCount","citationCount","mostImportantCitation","positiveSentiment","negativeSentiment"],"additionalProperties":false},{"type":"null"}]},"turns":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string","enum":["user","assistant"]},"body":{"type":"string"},"at":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"type":"string"},"sources":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"siteName":{"anyOf":[{"type":"string"},{"type":"null"}]},"faviconUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"faviconTone":{"anyOf":[{"type":"string","enum":["dark","light","mixed","unknown"]},{"type":"null"}]},"faviconTransparent":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"faviconNeedsLightBackplate":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"faviconNeedsDarkBackplate":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["url"],"additionalProperties":false}},"searchQueries":{"type":"array","items":{"type":"string"}}},"required":["id","role","body"],"additionalProperties":false}}},"required":["id","campaignId","campaignName","engine","engineId","occurredAt","scoring","outcomeSummary","turns"],"additionalProperties":false},"BusinessCustomerAudiencesCreateRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"customerIds":{"description":"Active customers to add to the audience now","minItems":1,"maxItems":1000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},"required":["name"],"additionalProperties":false},"BusinessCustomerAudiencesCreateResponse":{"type":"object","properties":{"audience":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"createdBy":{"type":"string","enum":["system","user"]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","createdBy","description"],"additionalProperties":false},"reused":{"type":"boolean"},"membership":{"anyOf":[{"$ref":"#/components/schemas/BusinessCustomerAudienceMembershipsUpdateResponse"},{"type":"null"}]}},"required":["audience","reused","membership"],"additionalProperties":false},"BusinessCustomerAudiencesUpdateRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":120}},"required":["id","name"],"additionalProperties":false},"BusinessCustomerAudiencesUpdateResponse":{"type":"object","properties":{"audience":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"createdBy":{"type":"string","enum":["system","user"]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","createdBy","description"],"additionalProperties":false}},"required":["audience"],"additionalProperties":false},"BusinessCustomerAudiencesDeleteRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["id"],"additionalProperties":false},"BusinessCustomerAudiencesDeleteResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["id"],"additionalProperties":false},"BusinessCustomerAudienceMembershipsUpdateRequest":{"type":"object","properties":{"customerIds":{"minItems":1,"maxItems":1000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"addAudienceIds":{"default":[],"maxItems":100,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"removeAudienceIds":{"default":[],"maxItems":100,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"acknowledgedCampaignIds":{"description":"The campaigns a refused change named (details.impact.acknowledgementCampaignIds), to confirm it","maxItems":100,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},"required":["customerIds"],"additionalProperties":false},"BusinessCustomerAudienceMembershipsUpdateResponse":{"type":"object","properties":{"evaluatedCustomerCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"changedCustomerCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"unchangedCustomerCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"impact":{"type":"object","properties":{"campaigns":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"status":{"type":"string","enum":["active","paused"]},"affectedCustomerCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["id","name","status","affectedCustomerCount"],"additionalProperties":false}},"acknowledgementCampaignIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},"required":["campaigns","acknowledgementCampaignIds"],"additionalProperties":false}},"required":["evaluatedCustomerCount","changedCustomerCount","unchangedCustomerCount","impact"],"additionalProperties":false},"BusinessManualProfileOptionsGetResponse":{"type":"object","properties":{"baseGenerationProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"baseSourceHash":{"type":"string"},"dimensions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","enum":["job_mix","audience_mix","channel_mix","revenue_mix","intent_stage_mix","age_mix","gender_mix","education_mix","household_income_mix","urbanicity_mix","regional_mix","life_stage_mix","language_mix","occupation_mix","company_size_mix","buyer_role_mix","seniority_mix","job_title_mix","years_in_role_mix"]},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"weightPct":{"type":"number"},"purchaseMode":{"type":"string","enum":["on_premises","local_service_area","remote_direct","third_party","sales_led"]},"revenueLineIds":{"type":"array","items":{"type":"string"}}},"required":["id","label","weightPct"],"additionalProperties":false}}},"required":["id","options"],"additionalProperties":false}}},"required":["baseGenerationProfileId","baseSourceHash","dimensions"],"additionalProperties":false},"BusinessManualProfileOptionsGetV2Response":{"type":"object","properties":{"baseGenerationProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"baseSourceHash":{"type":"string"},"dimensions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","enum":["job_mix","trigger_type_mix","audience_mix","channel_mix","revenue_mix","intent_stage_mix","age_mix","gender_mix","education_mix","household_income_mix","urbanicity_mix","regional_mix","life_stage_mix","language_mix","occupation_mix","company_size_mix","buyer_role_mix","seniority_mix","job_title_mix","years_in_role_mix"]},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"weightPct":{"type":"number"},"purchaseMode":{"type":"string","enum":["on_premises","local_service_area","remote_direct","third_party","sales_led"]},"revenueLineIds":{"type":"array","items":{"type":"string"}}},"required":["id","label","weightPct"],"additionalProperties":false}}},"required":["id","options"],"additionalProperties":false}}},"required":["baseGenerationProfileId","baseSourceHash","dimensions"],"additionalProperties":false},"BusinessManualProfilesCreateRequest":{"type":"object","properties":{"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"overrideManifest":{"oneOf":[{"$ref":"#/components/schemas/DiscoveryOverrideManifest"},{"$ref":"#/components/schemas/DiscoveryItemOverrideManifest"}],"description":"The Manual Profile card: the base it is built on (from business_manual_profile_options_get_v2), its name, and each chosen dimension's values and shares"},"descriptionId":{"description":"The business_customer_descriptions_create result this card came from","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customerGeneration":{"description":"Also generate this many customers from the new profile in the same run","type":"object","properties":{"targetCount":{"type":"integer","minimum":1,"maximum":5000},"groupName":{"type":"string","minLength":1,"maxLength":120}},"required":["targetCount"],"additionalProperties":false}},"required":["businessProfileId","overrideManifest"],"additionalProperties":false,"deprecated":true},"BusinessManualProfilesCreateResponse":{"type":"object","properties":{"runId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"profileName":{"type":"string"}},"required":["runId","businessProfileId","profileName"],"additionalProperties":false},"BusinessManualProfilesCreateV2Request":{"type":"object","properties":{"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"overrideManifest":{"type":"object","properties":{"version":{"type":"number","const":3},"baseGenerationProfileId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"baseSourceHash":{"type":"string","pattern":"^[a-f0-9]{64}$"},"profileName":{"type":"string","minLength":1,"maxLength":160},"overrides":{"$ref":"#/components/schemas/DiscoveryOverrides"},"givenFacts":{"$ref":"#/components/schemas/DiscoveryGivenFacts"}},"required":["version","baseGenerationProfileId","baseSourceHash","profileName","overrides"],"additionalProperties":false,"description":"The Manual Profile card: the base it is built on (from business_manual_profile_options_get_v2), its name, and each chosen dimension's values and shares"},"descriptionId":{"description":"The business_customer_descriptions_create result this card came from","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customerGeneration":{"description":"Also generate this many customers from the new profile in the same run","type":"object","properties":{"targetCount":{"type":"integer","minimum":1,"maximum":5000},"groupName":{"type":"string","minLength":1,"maxLength":120}},"required":["targetCount"],"additionalProperties":false}},"required":["businessProfileId","overrideManifest"],"additionalProperties":false},"BusinessManualProfilesCreateV2Response":{"type":"object","properties":{"runId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"profileName":{"type":"string"}},"required":["runId","businessProfileId","profileName"],"additionalProperties":false},"BusinessManualProfilesGetResponse":{"type":"object","properties":{"status":{"type":"string","enum":["pending","ready","failed"]},"generationProfileId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"businessProfileId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"profileName":{"anyOf":[{"type":"string"},{"type":"null"}]},"notSupported":{"type":"array","items":{"type":"string"}},"message":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["status","generationProfileId","businessProfileId","profileName","notSupported","message"],"additionalProperties":false},"BusinessCustomerPacksListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"Bumps whenever a change to the pack would make different people"},"family":{"type":"string","enum":["affinity","in_market","life_event","demographic","business"],"description":"Google Ads' audience segment types: affinity, a sustained interest or shopping habit with no purchase implied; in_market, comparing options now; life_event, a timed transition; demographic, who someone is, their household or life stage. And business, a professional role in a company's purchase"},"name":{"type":"string","description":"The pack's name, and the audience name its customers join"},"description":{"type":"string"},"buyerType":{"type":"string","enum":["consumer","organization"]},"approach":{"type":"string","enum":["first_impressions","buying_scenario"],"description":"How a creative test with the pack starts: reacting as themselves, or in the stated buying situation"},"buyingSituation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The buying situation a creative test states; null unless approach is buying_scenario"},"standbyCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"How many prewritten people the pack holds: the most business_customer_packs_apply makes customers"},"card":{"$ref":"#/components/schemas/BusinessCard"},"unavailableReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"audience":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"eligibleCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["id","eligibleCount"],"additionalProperties":false},{"type":"null"}]}},"required":["key","revision","family","name","description","buyerType","approach","buyingSituation","standbyCount","card","unavailableReason","audience"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"BusinessCustomerPacksApplyRequest":{"type":"object","properties":{"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The business profile whose customers they become"},"packKey":{"type":"string","minLength":1,"maxLength":120,"description":"The pack's key, from business_customer_packs_list"},"count":{"type":"integer","minimum":1,"maximum":400,"description":"How many of the pack's people, from its first"}},"required":["businessProfileId","packKey","count"],"additionalProperties":false},"BusinessCustomerPacksApplyResponse":{"type":"object","properties":{"audienceId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The audience of the pack's name"},"audienceName":{"type":"string"},"customerIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":"The pack's customers on this profile, in the pack's order"},"added":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"How many of them this call added"}},"required":["audienceId","audienceName","customerIds","added"],"additionalProperties":false},"BusinessCustomerDescriptionsCreateV3Request":{"type":"object","properties":{"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":{"type":"string","minLength":1,"maxLength":50000},"profileName":{"type":"string","minLength":1,"maxLength":160,"description":"The name the resulting Manual Profile takes"},"contentLanguage":{"type":"string","enum":["en","fr","es","de","pt","ja","it","nl","sv","cs","pl","tr","ru","zh-Hans","ko","ar"]}},"required":["businessProfileId","description","profileName","contentLanguage"],"additionalProperties":false},"BusinessCustomerDescriptionsCreateV3Response":{"type":"object","properties":{"descriptionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"outcome":{"type":"string","enum":["interpreted","no_customers_described","language_unsupported"]},"review":{"$ref":"#/components/schemas/BusinessReview"},"unresolved":{"type":"array","items":{"type":"object","properties":{"phrase":{"type":"string"},"explanation":{"type":"string"}},"required":["phrase","explanation"],"additionalProperties":false}},"manifest":{"$ref":"#/components/schemas/BusinessCard"},"dropped":{"type":"array","items":{"type":"string","enum":["gender","age","language","location","market","areaType","education","lifeStage","household","householdIncome","jobTitle","occupation","seniority","employer","yearsInRole","companySize","annualRevenue","audience","product","channel","buyerRole","stakeholders","intentStage","budget","constraints","job","situation","triggerType","trigger","functionalNeed","emotionalNeed","socialNeed","desiredOutcome","labels"]}},"products":{"$ref":"#/components/schemas/BusinessProducts"}},"required":["descriptionId","outcome","review","unresolved","manifest","dropped","products"],"additionalProperties":false},"BusinessCustomerDescriptionsGetResponse":{"type":"object","properties":{"descriptionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"outcome":{"type":"string","enum":["interpreted","no_customers_described","language_unsupported"]},"review":{"$ref":"#/components/schemas/BusinessReview"},"unresolved":{"type":"array","items":{"type":"object","properties":{"phrase":{"type":"string"},"explanation":{"type":"string"}},"required":["phrase","explanation"],"additionalProperties":false}},"manifest":{"$ref":"#/components/schemas/BusinessCard"},"dropped":{"type":"array","items":{"type":"string","enum":["gender","age","language","location","market","areaType","education","lifeStage","household","householdIncome","jobTitle","occupation","seniority","employer","yearsInRole","companySize","annualRevenue","audience","product","channel","buyerRole","stakeholders","intentStage","budget","constraints","job","situation","triggerType","trigger","functionalNeed","emotionalNeed","socialNeed","desiredOutcome","labels"]}},"products":{"$ref":"#/components/schemas/BusinessProducts"}},"required":["descriptionId","outcome","review","unresolved","manifest","dropped","products"],"additionalProperties":false},"BusinessCustomerEditReviewsCreateV4Request":{"type":"object","properties":{"customerIds":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":"The selected customers' ids (1–20)"},"messages":{"minItems":1,"maxItems":40,"type":"array","items":{"type":"object","properties":{"role":{"type":"string","enum":["member","assistant"]},"text":{"type":"string","minLength":1,"maxLength":2000}},"required":["role","text"],"additionalProperties":false}},"readings":{"maxItems":34,"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["gender","age","language","location","market","areaType","education","lifeStage","household","householdIncome","jobTitle","occupation","seniority","employer","yearsInRole","companySize","annualRevenue","audience","product","channel","buyerRole","stakeholders","intentStage","budget","constraints","job","situation","triggerType","trigger","functionalNeed","emotionalNeed","socialNeed","desiredOutcome","labels"]},"summary":{"type":"string","minLength":1,"maxLength":280}},"required":["field","summary"],"additionalProperties":false}},"attachmentIds":{"maxItems":10,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},"required":["customerIds","messages","readings"],"additionalProperties":false,"deprecated":true},"BusinessCustomerEditReviewsCreateV4Response":{"type":"object","properties":{"runId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"optionSets":{"type":"array","items":{"type":"object","propertyNames":{"type":"string","enum":["gender","language","market","areaType","education","lifeStage","occupation","seniority","audience","product","channel","buyerRole","intentStage","job","triggerType","age.band","householdIncome.band","companySize.band"]},"additionalProperties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"memberAdded":{"type":"boolean"}},"required":["id","label","memberAdded"],"additionalProperties":false}}}},"customers":{"$ref":"#/components/schemas/BusinessCustomers"}},"required":["runId","optionSets","customers"],"additionalProperties":false},"BusinessCustomerEditReviewsCreateV5Request":{"type":"object","properties":{"customerIds":{"minItems":1,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":"The selected customers' ids, any number, each once"},"messages":{"minItems":1,"maxItems":40,"type":"array","items":{"type":"object","properties":{"role":{"type":"string","enum":["member","assistant"]},"text":{"type":"string","minLength":1,"maxLength":524288}},"required":["role","text"],"additionalProperties":false}},"readings":{"maxItems":34,"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["gender","age","language","location","market","areaType","education","lifeStage","household","householdIncome","jobTitle","occupation","seniority","employer","yearsInRole","companySize","annualRevenue","audience","product","channel","buyerRole","stakeholders","intentStage","budget","constraints","job","situation","triggerType","trigger","functionalNeed","emotionalNeed","socialNeed","desiredOutcome","labels"]},"summary":{"type":"string","minLength":1,"maxLength":280}},"required":["field","summary"],"additionalProperties":false}},"attachmentIds":{"maxItems":10,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"brief":{"description":"The decided reading of the conversation, in plain words, which the review applies as decided: which customers change and how, the shares across the whole selection, what follows from a change, and how each open choice was settled with the member. Readings still name the fields to change, and messages hold the member's own words","type":"string","minLength":1,"maxLength":8000}},"required":["customerIds","messages","readings"],"additionalProperties":false},"BusinessCustomerEditReviewsCreateV5Response":{"type":"object","properties":{"runId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The review run; follow it with business_customer_edit_reviews_get_v2"},"customerCount":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"The customers the review rewrites"},"batchCount":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"The writer calls it makes: one per batch of up to 20 customers, in the order selected"}},"required":["runId","customerCount","batchCount"],"additionalProperties":false},"BusinessCustomerEditReviewsGetResponse":{"type":"object","properties":{"runId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"status":{"type":"string","enum":["running","succeeded","failed"],"description":"running while any batch is pending; succeeded once every batch ended and at least one was accepted; failed when none was"},"customerCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"batches":{"type":"array","items":{"type":"object","properties":{"batch":{"type":"integer","minimum":0,"maximum":9007199254740991},"state":{"type":"string","enum":["pending","accepted","failed"]},"customerIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},"required":["batch","state","customerIds"],"additionalProperties":false}},"optionSets":{"type":"array","items":{"type":"object","propertyNames":{"type":"string","enum":["gender","language","market","areaType","education","lifeStage","occupation","seniority","audience","product","channel","buyerRole","intentStage","job","triggerType","age.band","householdIncome.band","companySize.band"]},"additionalProperties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"memberAdded":{"type":"boolean"}},"required":["id","label","memberAdded"],"additionalProperties":false}}}},"customers":{"$ref":"#/components/schemas/BusinessCustomers"},"request":{"type":"object","properties":{"customerIds":{"minItems":1,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":"The selected customers' ids, any number, each once"},"messages":{"minItems":1,"maxItems":40,"type":"array","items":{"type":"object","properties":{"role":{"type":"string","enum":["member","assistant"]},"text":{"type":"string","minLength":1,"maxLength":8000}},"required":["role","text"],"additionalProperties":false}},"readings":{"maxItems":34,"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["gender","age","language","location","market","areaType","education","lifeStage","household","householdIncome","jobTitle","occupation","seniority","employer","yearsInRole","companySize","annualRevenue","audience","product","channel","buyerRole","stakeholders","intentStage","budget","constraints","job","situation","triggerType","trigger","functionalNeed","emotionalNeed","socialNeed","desiredOutcome","labels"]},"summary":{"type":"string","minLength":1,"maxLength":280}},"required":["field","summary"],"additionalProperties":false}},"attachmentIds":{"maxItems":10,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"brief":{"description":"The decided reading of the conversation, in plain words, which the review applies as decided: which customers change and how, the shares across the whole selection, what follows from a change, and how each open choice was settled with the member. Readings still name the fields to change, and messages hold the member's own words","type":"string","minLength":1,"maxLength":8000}},"required":["customerIds","messages","readings"],"additionalProperties":false,"description":"The business_customer_edit_reviews_create_v5 input this review was started with: its customers in the order selected, the conversation, its readings, the brief and the files. Send it again, its customerIds narrowed to those to review again"}},"required":["runId","status","customerCount","batches","optionSets","customers","request"],"additionalProperties":false},"BusinessCustomerEditReviewsGetV2Response":{"type":"object","properties":{"runId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"status":{"type":"string","enum":["running","succeeded","failed"],"description":"running while any batch is pending; succeeded once every batch ended and at least one was accepted; failed when none was"},"customerCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"batches":{"type":"array","items":{"type":"object","properties":{"batch":{"type":"integer","minimum":0,"maximum":9007199254740991},"state":{"type":"string","enum":["pending","accepted","failed"]},"customerIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},"required":["batch","state","customerIds"],"additionalProperties":false}},"optionSets":{"type":"array","items":{"type":"object","propertyNames":{"type":"string","enum":["gender","language","market","areaType","education","lifeStage","occupation","seniority","audience","product","channel","buyerRole","intentStage","job","triggerType","age.band","householdIncome.band","companySize.band"]},"additionalProperties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"memberAdded":{"type":"boolean"}},"required":["id","label","memberAdded"],"additionalProperties":false}}}},"customers":{"$ref":"#/components/schemas/BusinessCustomers"},"request":{"type":"object","properties":{"customerIds":{"minItems":1,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":"The selected customers' ids, any number, each once"},"messages":{"minItems":1,"maxItems":40,"type":"array","items":{"type":"object","properties":{"role":{"type":"string","enum":["member","assistant"]},"text":{"type":"string","minLength":1,"maxLength":524288}},"required":["role","text"],"additionalProperties":false}},"readings":{"maxItems":34,"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["gender","age","language","location","market","areaType","education","lifeStage","household","householdIncome","jobTitle","occupation","seniority","employer","yearsInRole","companySize","annualRevenue","audience","product","channel","buyerRole","stakeholders","intentStage","budget","constraints","job","situation","triggerType","trigger","functionalNeed","emotionalNeed","socialNeed","desiredOutcome","labels"]},"summary":{"type":"string","minLength":1,"maxLength":280}},"required":["field","summary"],"additionalProperties":false}},"attachmentIds":{"maxItems":10,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"brief":{"description":"The decided reading of the conversation, in plain words, which the review applies as decided: which customers change and how, the shares across the whole selection, what follows from a change, and how each open choice was settled with the member. Readings still name the fields to change, and messages hold the member's own words","type":"string","minLength":1,"maxLength":8000}},"required":["customerIds","messages","readings"],"additionalProperties":false,"description":"The business_customer_edit_reviews_create_v5 input this review was started with: its customers in the order selected, the conversation, its readings, the brief and the files. Send it again, its customerIds narrowed to those to review again"}},"required":["runId","status","customerCount","batches","optionSets","customers","request"],"additionalProperties":false},"BusinessCustomerEditReviewsApplyV4Request":{"type":"object","properties":{"reviewRunId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The review run whose proposal to apply"},"customerIds":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":"The reviewed customers to apply, each with changes: up to 20 in one call, saved in one transaction; apply a larger review in parts"},"overrides":{"description":"What the member changed on the review before applying, per customer; Apply writes the review's proposal with these in place of the fields they name","maxItems":20,"type":"array","items":{"type":"object","properties":{"customerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"values":{"description":"Fields set on the review, by the customer model's keys, each replacing what it proposed or set beside it: a fact as text, a category as one of its option ids, the place; the name, which the review never proposes, as text","type":"object","properties":{"name":{"anyOf":[{"type":"string","maxLength":160},{"type":"null"}]},"gender":{"anyOf":[{"type":"string","pattern":"^(?:|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$"},{"type":"null"}]},"age":{"type":"object","properties":{"value":{"anyOf":[{"type":"string"},{"type":"null"}]},"band":{"anyOf":[{"type":"string","pattern":"^(?:|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$"},{"type":"null"}]}},"additionalProperties":false},"language":{"anyOf":[{"type":"string","pattern":"^(?:|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$"},{"type":"null"}]},"location":{"anyOf":[{"type":"object","properties":{"countryCode":{"anyOf":[{"type":"string","pattern":"^[A-Z]{2}$"},{"type":"null"}]},"subdivisionCode":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"locality":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"postalCode":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]},"country":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"subdivision":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},"required":["countryCode","subdivisionCode","locality","postalCode","country","subdivision"],"additionalProperties":false},{"type":"null"}]},"market":{"anyOf":[{"type":"string","pattern":"^(?:|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$"},{"type":"null"}]},"areaType":{"anyOf":[{"type":"string","pattern":"^(?:|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$"},{"type":"null"}]},"education":{"anyOf":[{"type":"string","pattern":"^(?:|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$"},{"type":"null"}]},"lifeStage":{"anyOf":[{"type":"string","pattern":"^(?:|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$"},{"type":"null"}]},"household":{"anyOf":[{"type":"object","properties":{"adults":{"anyOf":[{"type":"integer","minimum":0,"maximum":99},{"type":"null"}]},"children":{"anyOf":[{"type":"integer","minimum":0,"maximum":99},{"type":"null"}]},"pets":{"anyOf":[{"type":"integer","minimum":0,"maximum":99},{"type":"null"}]}},"required":["adults","children","pets"],"additionalProperties":false},{"type":"null"}]},"householdIncome":{"type":"object","properties":{"value":{"anyOf":[{"type":"string"},{"type":"null"}]},"band":{"anyOf":[{"type":"string","pattern":"^(?:|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$"},{"type":"null"}]}},"additionalProperties":false},"jobTitle":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"occupation":{"anyOf":[{"type":"string","pattern":"^(?:|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$"},{"type":"null"}]},"seniority":{"anyOf":[{"type":"string","pattern":"^(?:|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$"},{"type":"null"}]},"employer":{"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}]},"yearsInRole":{"anyOf":[{"type":"string"},{"type":"null"}]},"companySize":{"type":"object","properties":{"value":{"anyOf":[{"type":"string"},{"type":"null"}]},"band":{"anyOf":[{"type":"string","pattern":"^(?:|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$"},{"type":"null"}]}},"additionalProperties":false},"annualRevenue":{"anyOf":[{"type":"string"},{"type":"null"}]},"audience":{"anyOf":[{"type":"string","pattern":"^(?:|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$"},{"type":"null"}]},"product":{"anyOf":[{"type":"string","pattern":"^(?:|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$"},{"type":"null"}]},"channel":{"anyOf":[{"type":"string","pattern":"^(?:|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$"},{"type":"null"}]},"buyerRole":{"anyOf":[{"type":"string","pattern":"^(?:|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$"},{"type":"null"}]},"stakeholders":{"anyOf":[{"type":"string","maxLength":4000},{"type":"null"}]},"intentStage":{"anyOf":[{"type":"string","pattern":"^(?:|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$"},{"type":"null"}]},"budget":{"anyOf":[{"type":"string","maxLength":4000},{"type":"null"}]},"constraints":{"anyOf":[{"type":"string","maxLength":4000},{"type":"null"}]},"job":{"anyOf":[{"type":"string","pattern":"^(?:|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$"},{"type":"null"}]},"situation":{"anyOf":[{"type":"string","maxLength":4000},{"type":"null"}]},"triggerType":{"anyOf":[{"type":"string","pattern":"^(?:|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$"},{"type":"null"}]},"trigger":{"anyOf":[{"type":"string","maxLength":4000},{"type":"null"}]},"functionalNeed":{"anyOf":[{"type":"string","maxLength":4000},{"type":"null"}]},"emotionalNeed":{"anyOf":[{"type":"string","maxLength":4000},{"type":"null"}]},"socialNeed":{"anyOf":[{"type":"string","maxLength":4000},{"type":"null"}]},"desiredOutcome":{"anyOf":[{"type":"string","maxLength":4000},{"type":"null"}]}},"additionalProperties":false},"newValues":{"description":"Open categories stated in words, each replacing what the review proposed: the option with that label, else a new value for the customer's business profile","type":"object","properties":{"market":{"type":"string","minLength":1,"maxLength":200},"occupation":{"type":"string","minLength":1,"maxLength":200},"audience":{"type":"string","minLength":1,"maxLength":200},"product":{"type":"string","minLength":1,"maxLength":200},"channel":{"type":"string","minLength":1,"maxLength":200},"buyerRole":{"type":"string","minLength":1,"maxLength":200},"job":{"type":"string","minLength":1,"maxLength":200},"triggerType":{"type":"string","minLength":1,"maxLength":200}},"additionalProperties":false},"labels":{"description":"The labels to add the customer to, replacing the review's; [] adds none","maxItems":10,"type":"array","items":{"type":"string","minLength":1,"maxLength":120}},"product":{"description":"The customer's Product, replacing the review's: the revenue line id of one of its business profile's products (create a product the review proposed as new with business_revenue_lines_create_v2 first, then name it here); null keeps the product it has","anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},"required":["customerId"],"additionalProperties":false}}},"required":["reviewRunId","customerIds"],"additionalProperties":false},"BusinessCustomerEditReviewsApplyV4Response":{"type":"object","properties":{"customers":{"type":"array","items":{"type":"object","properties":{"customerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customerVersionId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"version":{"anyOf":[{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},{"type":"null"}]},"derivedFields":{"type":"array","items":{"type":"string","enum":["gender","age","age.band","language","location","market","areaType","education","lifeStage","household","householdIncome","householdIncome.band","jobTitle","occupation","seniority","employer","yearsInRole","companySize","companySize.band","annualRevenue","audience","product","channel","buyerRole","stakeholders","intentStage","budget","constraints","job","situation","triggerType","trigger","functionalNeed","emotionalNeed","socialNeed","desiredOutcome"]}},"newValues":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["market","occupation","audience","product","channel","buyerRole","job","triggerType"]},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"label":{"type":"string"},"created":{"type":"boolean"}},"required":["field","id","label","created"],"additionalProperties":false}},"place":{"anyOf":[{"oneOf":[{"type":"object","properties":{"outcome":{"type":"string","const":"placed"},"subdivisionCode":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["outcome","subdivisionCode"],"additionalProperties":false},{"type":"object","properties":{"outcome":{"type":"string","const":"unresolved"},"reason":{"type":"string"}},"required":["outcome","reason"],"additionalProperties":false},{"type":"object","properties":{"outcome":{"type":"string","const":"unchecked"}},"required":["outcome"],"additionalProperties":false}]},{"type":"null"}]}},"required":["customerId","customerVersionId","version","derivedFields","newValues","place"],"additionalProperties":false}},"labels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"created":{"type":"boolean"},"customerIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},"required":["id","name","created","customerIds"],"additionalProperties":false}},"rerun":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The edit's rerun request; list its reruns with campaigns_member_reruns_list_v1"},"joinedRequestIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":"Earlier edits' rerun requests this edit joined: a customer whose rerun an earlier edit asked for has not started yet reruns once, on its newest version, and that rerun is listed under the earlier request, not requestId"},"customers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Customers that rerun"},"campaigns":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Campaigns they rerun in"},"skipped":{"$ref":"#/components/schemas/BusinessSkipped"}},"required":["requestId","joinedRequestIds","customers","campaigns","skipped"],"additionalProperties":false,"description":"The apply's rerun: the customers that got a new version rerun in their live campaigns; none when the apply only added labels"}},"required":["customers","labels","rerun"],"additionalProperties":false},"BusinessCrmSeedOptionsGetResponse":{"type":"object","properties":{"options":{"anyOf":[{"type":"object","properties":{"total":{"type":"object","properties":{"tier":{"anyOf":[{"type":"string"},{"type":"null"}]},"rows":{"type":"integer","minimum":0,"maximum":9007199254740991},"accountRows":{"type":"integer","minimum":0,"maximum":9007199254740991},"delivered":{"type":"integer","minimum":0,"maximum":9007199254740991},"undelivered":{"type":"integer","minimum":0,"maximum":9007199254740991},"remaining":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["tier","rows","accountRows","delivered","undelivered","remaining"],"additionalProperties":false},"segments":{"type":"array","items":{"type":"object","properties":{"tier":{"anyOf":[{"type":"string"},{"type":"null"}]},"rows":{"type":"integer","minimum":0,"maximum":9007199254740991},"accountRows":{"type":"integer","minimum":0,"maximum":9007199254740991},"delivered":{"type":"integer","minimum":0,"maximum":9007199254740991},"undelivered":{"type":"integer","minimum":0,"maximum":9007199254740991},"remaining":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["tier","rows","accountRows","delivered","undelivered","remaining"],"additionalProperties":false}},"buyerRoles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"}},"required":["id","label"],"additionalProperties":false}}},"required":["total","segments","buyerRoles"],"additionalProperties":false},{"type":"null"}]}},"required":["options"],"additionalProperties":false},"BusinessCustomerGenerationSourcesGetResponse":{"type":"object","properties":{"sources":{"type":"array","items":{"type":"object","properties":{"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"profileKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"type":"string"},"normalizedUrl":{"type":"string"},"contentLanguage":{"type":"string","enum":["en","fr","es","de","pt","ja","it","nl","sv","cs","pl","tr","ru","zh-Hans","ko","ar"]},"generationProfileId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"forecastId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"forecastGenerationProfileId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["businessProfileId","profileKey","label","normalizedUrl","contentLanguage","generationProfileId","forecastId","forecastGenerationProfileId"],"additionalProperties":false}}},"required":["sources"],"additionalProperties":false},"BusinessCustomerFilterOptionsGetV2Response":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["performance","gender","age.band","language","market","areaType","education","lifeStage","householdIncome.band","occupation","seniority","companySize.band","buyerType","audience","product","channel","buyerRole","intentStage","job","triggerType"]},"options":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"ids":{"minItems":1,"type":"array","items":{"type":"string"}},"count":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["label","ids","count"],"additionalProperties":false}},"noValueCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["field","options","noValueCount"],"additionalProperties":false}}},"required":["fields"],"additionalProperties":false},"BusinessCustomerInterviewsStartRequest":{"type":"object","properties":{"customerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["customerId"],"additionalProperties":false},"BusinessCustomerInterviewsStartResponse":{"type":"object","properties":{"conversationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"eveSession":{"anyOf":[{"type":"object","properties":{"sessionId":{"type":"string"},"streamIndex":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["sessionId","streamIndex"],"additionalProperties":false},{"type":"null"}]},"customerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customerName":{"type":"string"},"groundingProvider":{"anyOf":[{"type":"string","enum":["hubspot","salesforce"]},{"type":"null"}]},"deploymentId":{"type":"string"},"messages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string","enum":["system","user","assistant"]},"parts":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"}},"required":["type"],"additionalProperties":{"$ref":"#/components/schemas/__schema0"}}}},"required":["id","role","parts"],"additionalProperties":{"$ref":"#/components/schemas/__schema1"}}},"pendingMessage":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"turnIntentId":{"type":"string"},"userMessageId":{"type":"string"}},"required":["message","turnIntentId","userMessageId"],"additionalProperties":false},{"type":"null"}]},"pathname":{"type":"string"}},"required":["conversationId","eveSession","customerId","customerName","groundingProvider","deploymentId","messages","pendingMessage","pathname"],"additionalProperties":false},"BusinessProfileRowsListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"profileId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"profileKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"url":{"type":"string"},"businessSummary":{"anyOf":[{"type":"string"},{"type":"null"}]},"subjectType":{"anyOf":[{"type":"string","enum":["person","business","nonprofit","public_institution","product_or_offering"]},{"type":"null"}]},"customerCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"campaignCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"versionCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"providerCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"partial":{"type":"boolean"},"generatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"lifecycleStatus":{"type":"string","enum":["active","archived","deleted"]},"archivedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"deletedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"artifactAvailable":{"type":"boolean"},"latestAttemptState":{"anyOf":[{"type":"string","enum":["running","succeeded","failed","cancelled","partial"]},{"type":"null"}]},"generationProgress":{"anyOf":[{"type":"object","properties":{"state":{"type":"string"},"label":{"type":"string"},"takingLonger":{"type":"boolean"},"executionStatus":{"type":"string","enum":["waiting","running"]}},"required":["state","label","takingLonger","executionStatus"],"additionalProperties":false},{"type":"null"}]},"publicSupportReference":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","profileId","profileKey","name","url","businessSummary","subjectType","customerCount","campaignCount","versionCount","providerCount","partial","generatedAt","updatedAt","lifecycleStatus","archivedAt","deletedAt","artifactAvailable","latestAttemptState","generationProgress","publicSupportReference"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"totalCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"hasActiveGeneration":{"type":"boolean"}},"required":["data","nextCursor","totalCount","hasActiveGeneration"],"additionalProperties":false},"BusinessProfilesGetResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"profileKey":{"type":"string"},"store":{"anyOf":[{"type":"object","properties":{"profileKey":{"type":"string"},"locationKey":{"type":"string"}},"required":["profileKey","locationKey"],"additionalProperties":false},{"type":"null"}]},"profile":{"anyOf":[{"$ref":"#/components/schemas/BusinessProfile3"},{"type":"null"}]},"capabilities":{"$ref":"#/components/schemas/BusinessCapabilities"}},"required":["id","profileKey","store","profile","capabilities"],"additionalProperties":false},"BusinessProfilesCheckRequest":{"type":"object","properties":{"description":{"type":"string","minLength":1,"maxLength":10000,"description":"Who or what the profile is about, in the member's own words, for a subject with no website to start from: a person, practice, product or offering. Research identifies it from these words and any attached files."},"attachmentIds":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":"Ids of ready uploads to attach to the description"}},"required":["description"],"additionalProperties":false},"BusinessProfilesCheckResponse":{"type":"object","properties":{"attachments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"filename":{"type":"string"},"mediaType":{"type":"string"},"byteLength":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["id","filename","mediaType","byteLength"],"additionalProperties":false},"description":"The attached files generate will read, as their uploads were admitted"},"match":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"This match's id: pass it with the chosen candidateIndex as business_profiles_generate's subjectMatch"},"reading":{"type":"object","properties":{"subject":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"entityType":{"anyOf":[{"type":"string","enum":["person","business","nonprofit","public_institution","product_or_offering"]},{"type":"null"}]},"affiliation":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"role":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"location":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"website":{"anyOf":[{"type":"string","minLength":1,"maxLength":2048},{"type":"null"}]}},"required":["subject","entityType","affiliation","role","location","website"],"additionalProperties":false,"description":"What the description's own words say about its subject; null where they say nothing"},"candidates":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"entityType":{"type":"string","enum":["person","business","nonprofit","public_institution","product_or_offering"]},"affiliation":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"role":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"location":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"website":{"anyOf":[{"type":"string","minLength":1,"maxLength":2048},{"type":"null"}]},"summary":{"type":"string","minLength":1,"maxLength":300}},"required":["name","entityType","affiliation","role","location","website","summary"],"additionalProperties":false},"description":"Public matches a web search found for the description, best first; empty when it found none"}},"required":["id","reading","candidates"],"additionalProperties":false}},"required":["attachments","match"],"additionalProperties":false},"BusinessProfilesGetV2Response":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"profileKey":{"type":"string"},"store":{"anyOf":[{"type":"object","properties":{"profileKey":{"type":"string"},"locationKey":{"type":"string"}},"required":["profileKey","locationKey"],"additionalProperties":false},{"type":"null"}]},"profile":{"anyOf":[{"$ref":"#/components/schemas/BusinessProfile4"},{"type":"null"}]},"capabilities":{"$ref":"#/components/schemas/BusinessCapabilities"}},"required":["id","profileKey","store","profile","capabilities"],"additionalProperties":false},"BusinessProfilesGenerateRequest":{"type":"object","properties":{"url":{"description":"The business's website URL; omit it to profile a description instead","type":"string","minLength":1,"maxLength":2048},"description":{"type":"string","minLength":1,"maxLength":10000,"description":"Who or what the profile is about, in the member's own words, for a subject with no website to start from: a person, practice, product or offering. Research identifies it from these words and any attached files."},"attachmentIds":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":"Ids of ready uploads to attach to the description"},"subjectMatch":{"description":"With a description: the business_profiles_check match and the candidate the member confirmed, which every research step then reads with the words","type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The match id business_profiles_check returned"},"candidateIndex":{"anyOf":[{"type":"integer","minimum":0,"maximum":4},{"type":"null"}],"description":"The chosen candidate's position in that match's candidates; null for none of them"}},"required":["id","candidateIndex"],"additionalProperties":false},"place":{"description":"Instead of a website or a description: a store of a brand business profile with no place profile of its own yet, researched at the place its earlier research recorded","type":"object","properties":{"profileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The brand business profile the store is listed under"},"locationKey":{"type":"string","minLength":1,"maxLength":500,"description":"The store's location key, as business_store_profile_summaries_get lists it"}},"required":["profileId","locationKey"],"additionalProperties":false}},"additionalProperties":false},"BusinessProfilesGenerateResponse":{"type":"object","properties":{"runId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["runId"],"additionalProperties":false},"BusinessProfilesRefreshRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The profile's id"}},"required":["id"],"additionalProperties":false},"BusinessProfilesRefreshResponse":{"type":"object","properties":{"runId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["runId"],"additionalProperties":false},"BusinessProfileEditValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"$ref":"#/components/schemas/BusinessProfileEditValue"}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/BusinessProfileEditValue"}}]},"BusinessProfilesUpdateRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The profile's id"},"expectedVersionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The versionId business_profile_edit_sources_get answered"},"expectedName":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The expectedName business_profile_edit_sources_get answered"},"values":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/BusinessProfileEditValue"},"description":"The edit source's values, with your changes"}},"required":["id","expectedVersionId","expectedName","values"],"additionalProperties":false},"BusinessProfilesUpdateResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"versionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["id","versionId"],"additionalProperties":false},"BusinessProfilesArchiveRequest":{"type":"object","properties":{"profileIds":{"minItems":1,"maxItems":1000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":"The profiles' ids (1–1000)"}},"required":["profileIds"],"additionalProperties":false},"BusinessProfilesArchiveResponse":{"type":"object","properties":{"command":{"type":"string","enum":["archive","restore"]},"changedCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["command","changedCount"],"additionalProperties":false},"BusinessProfilesRestoreRequest":{"type":"object","properties":{"profileIds":{"minItems":1,"maxItems":1000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":"The profiles' ids (1–1000)"}},"required":["profileIds"],"additionalProperties":false},"BusinessProfilesRestoreResponse":{"type":"object","properties":{"command":{"type":"string","enum":["archive","restore"]},"changedCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["command","changedCount"],"additionalProperties":false},"BusinessProfilesDeleteRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The profile's id"},"impactHash":{"type":"string","minLength":1,"maxLength":128,"description":"The impactHash business_profile_lifecycle_impacts_get answered for delete"}},"required":["id","impactHash"],"additionalProperties":false},"BusinessProfilesDeleteResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"status":{"type":"string","const":"deleted"}},"required":["id","status"],"additionalProperties":false},"BusinessProfileLifecycleImpactsGetResponse":{"type":"object","properties":{"action":{"type":"string","enum":["archive","restore","delete"]},"summary":{"type":"object","properties":{"exists":{"type":"boolean"},"profileId":{"type":"string"},"parentProfileId":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string","enum":["active","archived","deleted"]},{"type":"null"}]},"normalizedUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"archivedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"deletedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"places":{"type":"array","items":{"type":"object","properties":{"profileId":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"locationKey":{"type":"string"},"status":{"type":"string","enum":["active","archived","deleted"]}},"required":["profileId","name","locationKey","status"],"additionalProperties":false}},"campaigns":{"type":"object","properties":{"discovery":{"type":"object","properties":{"active":{"type":"integer","minimum":0,"maximum":9007199254740991},"paused":{"type":"integer","minimum":0,"maximum":9007199254740991},"archived":{"type":"integer","minimum":0,"maximum":9007199254740991},"deleted":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["active","paused","archived","deleted"],"additionalProperties":false},"research":{"type":"object","properties":{"active":{"type":"integer","minimum":0,"maximum":9007199254740991},"paused":{"type":"integer","minimum":0,"maximum":9007199254740991},"archived":{"type":"integer","minimum":0,"maximum":9007199254740991},"deleted":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["active","paused","archived","deleted"],"additionalProperties":false},"experience":{"type":"object","properties":{"active":{"type":"integer","minimum":0,"maximum":9007199254740991},"paused":{"type":"integer","minimum":0,"maximum":9007199254740991},"archived":{"type":"integer","minimum":0,"maximum":9007199254740991},"deleted":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["active","paused","archived","deleted"],"additionalProperties":false}},"required":["discovery","research","experience"],"additionalProperties":false},"customers":{"type":"object","properties":{"active":{"type":"integer","minimum":0,"maximum":9007199254740991},"retired":{"type":"integer","minimum":0,"maximum":9007199254740991},"softDeleted":{"type":"integer","minimum":0,"maximum":9007199254740991},"sampled":{"type":"integer","minimum":0,"maximum":9007199254740991},"unsampled":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["active","retired","softDeleted","sampled","unsampled"],"additionalProperties":false},"artifacts":{"type":"object","properties":{"profileVersions":{"type":"integer","minimum":0,"maximum":9007199254740991},"forecasts":{"type":"integer","minimum":0,"maximum":9007199254740991},"generationProfiles":{"type":"integer","minimum":0,"maximum":9007199254740991},"crmUploads":{"type":"integer","minimum":0,"maximum":9007199254740991},"campaignRosterRows":{"type":"integer","minimum":0,"maximum":9007199254740991},"inFlightRuns":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["profileVersions","forecasts","generationProfiles","crmUploads","campaignRosterRows","inFlightRuns"],"additionalProperties":false},"blockers":{"type":"array","items":{"type":"string"}},"warnings":{"type":"array","items":{"type":"string"}}},"required":["exists","profileId","parentProfileId","status","normalizedUrl","name","archivedAt","deletedAt","places","campaigns","customers","artifacts","blockers","warnings"],"additionalProperties":false},"capabilities":{"$ref":"#/components/schemas/BusinessCapabilitiesVariant"},"blockers":{"type":"array","items":{"type":"string"}},"warnings":{"type":"array","items":{"type":"string"}},"requiresConfirmation":{"type":"boolean"},"impactHash":{"type":"string"}},"required":["action","summary","capabilities","blockers","warnings","requiresConfirmation","impactHash"],"additionalProperties":false},"BusinessProfileEditField":{"type":"object","properties":{"type":{"type":"string","enum":["object","array","string","number","boolean"]},"label":{"type":"string"},"identity":{"type":"boolean"},"location":{"type":"boolean"},"discriminator":{"type":"string"},"variants":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/BusinessProfileEditField"}},"referenceCatalog":{"type":"string"},"nullable":{"type":"boolean"},"optional":{"type":"boolean"},"options":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"}]}},"optionLabels":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"minimum":{"type":"number"},"maximum":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"maxLength":{"type":"number"},"format":{"type":"string"},"properties":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/BusinessProfileEditField"}},"items":{"$ref":"#/components/schemas/BusinessProfileEditField"}},"required":["type","label"],"additionalProperties":false},"BusinessProfileEditSourcesGetResponse":{"type":"object","properties":{"profileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"versionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"expectedName":{"anyOf":[{"type":"string"},{"type":"null"}]},"fields":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/BusinessProfileEditField"}},"values":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/BusinessProfileEditValue"}}},"required":["profileId","versionId","expectedName","fields","values"],"additionalProperties":false},"BusinessProfilePlacesSearchResponse":{"type":"object","properties":{"places":{"type":"array","items":{"type":"object","properties":{"recordId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"displayName":{"type":"string"}},"required":["recordId","displayName"],"additionalProperties":false}}},"required":["places"],"additionalProperties":false},"BusinessForecastsGetResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"forecastKey":{"type":"string"},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"status":{"type":"string","enum":["active","archived","deleted"]},"current":{"type":"boolean"},"contentLanguage":{"type":"string","enum":["en","fr","es","de","pt","ja","it","nl","sv","cs","pl","tr","ru","zh-Hans","ko","ar"]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"profileKey":{"type":"string"}},"required":["id","forecastKey","version","status","current","contentLanguage","createdAt","businessProfileId","profileKey"],"additionalProperties":false},"BusinessStoreProfilesGetResponse":{"type":"object","properties":{"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"profileKey":{"type":"string"},"locationKey":{"type":"string"},"placeProfileId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"storeLabel":{"type":"string"},"brandName":{"type":"string"},"profile":{"$ref":"#/components/schemas/BusinessProfile3"},"navigation":{"anyOf":[{"type":"object","properties":{"position":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"total":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"previous":{"anyOf":[{"type":"object","properties":{"locationKey":{"type":"string"},"label":{"type":"string"}},"required":["locationKey","label"],"additionalProperties":false},{"type":"null"}]},"next":{"anyOf":[{"type":"object","properties":{"locationKey":{"type":"string"},"label":{"type":"string"}},"required":["locationKey","label"],"additionalProperties":false},{"type":"null"}]}},"required":["position","total","previous","next"],"additionalProperties":false},{"type":"null"}]}},"required":["businessProfileId","profileKey","locationKey","placeProfileId","storeLabel","brandName","profile","navigation"],"additionalProperties":false},"BusinessStoreProfilesGetV2Response":{"type":"object","properties":{"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"profileKey":{"type":"string"},"locationKey":{"type":"string"},"placeProfileId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"storeLabel":{"type":"string"},"brandName":{"type":"string"},"profile":{"$ref":"#/components/schemas/BusinessProfile4"},"navigation":{"anyOf":[{"type":"object","properties":{"position":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"total":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"previous":{"anyOf":[{"type":"object","properties":{"locationKey":{"type":"string"},"label":{"type":"string"}},"required":["locationKey","label"],"additionalProperties":false},{"type":"null"}]},"next":{"anyOf":[{"type":"object","properties":{"locationKey":{"type":"string"},"label":{"type":"string"}},"required":["locationKey","label"],"additionalProperties":false},{"type":"null"}]}},"required":["position","total","previous","next"],"additionalProperties":false},{"type":"null"}]}},"required":["businessProfileId","profileKey","locationKey","placeProfileId","storeLabel","brandName","profile","navigation"],"additionalProperties":false},"BusinessStoreProfileSummariesGetResponse":{"type":"object","properties":{"stores":{"type":"array","items":{"type":"object","properties":{"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"locationKey":{"type":"string"},"label":{"type":"string"},"locality":{"anyOf":[{"type":"string"},{"type":"null"}]},"customerCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["businessProfileId","locationKey","label","locality","customerCount"],"additionalProperties":false}}},"required":["stores"],"additionalProperties":false},"BusinessProfileAttachmentsReserveUploadRequest":{"type":"object","properties":{"filename":{"type":"string","minLength":1,"maxLength":255,"description":"The file's name as the member sees it."},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":4194304,"description":"Exact size in bytes: an image or a PDF at most 4 MiB, a text file at most 256 KB."},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$","description":"Lowercase hex SHA-256 of the exact bytes you will upload."}},"required":["filename","mediaType","byteLength","sha256"],"additionalProperties":false},"BusinessProfileAttachmentsReserveUploadResponse":{"type":"object","properties":{"attachment":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"filename":{"type":"string"},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"status":{"type":"string","enum":["pending","ready"],"description":"pending until business_profile_attachments_complete_upload proves the upload."}},"required":["id","filename","mediaType","byteLength","status"],"additionalProperties":false},"upload":{"anyOf":[{"type":"object","properties":{"method":{"type":"string","const":"PUT"},"url":{"type":"string","format":"uri"},"headers":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"expiresAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["method","url","headers","expiresAt"],"additionalProperties":false},{"type":"null"}],"description":"Send the file as the body of exactly this request before expiresAt; the response body is JSON naming the stored file's etag. Null when the file was already uploaded: call business_profile_attachments_complete_upload."}},"required":["attachment","upload"],"additionalProperties":false},"BusinessProfileAttachmentsCompleteUploadRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The attachment id reserve-upload returned."},"etag":{"description":"The etag the upload's response named; omit to recover it from the store.","type":"string","minLength":1,"maxLength":1024}},"required":["id"],"additionalProperties":false},"BusinessProfileAttachmentsCompleteUploadResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"filename":{"type":"string"},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"status":{"type":"string","const":"ready"}},"required":["id","filename","mediaType","byteLength","status"],"additionalProperties":false},"BusinessCampaignCustomerPoolsGetResponse":{"type":"object","properties":{"businessProfileId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"Null when no profile can launch."},"hasForecast":{"type":"boolean"},"allEligibleCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"audiences":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"eligibleCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"lane":{"anyOf":[{"type":"string","enum":["Profile","Forecast","CRM upload","Manual"]},{"type":"null"}],"description":"The generation source a system source row names; null for an audience."}},"required":["id","name","eligibleCount","lane"],"additionalProperties":false}}},"required":["businessProfileId","hasForecast","allEligibleCount","audiences"],"additionalProperties":false},"BusinessCampaignCustomerPoolsGetV2Response":{"type":"object","properties":{"businessProfileId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"Null when no profile can launch."},"hasForecast":{"type":"boolean"},"allEligibleCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"audiences":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"eligibleCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"lane":{"anyOf":[{"type":"string","enum":["Profile","Forecast","CRM upload","Manual"]},{"type":"null"}],"description":"The generation source a system source row names; null for an audience."}},"required":["id","name","eligibleCount","lane"],"additionalProperties":false}}},"required":["businessProfileId","hasForecast","allEligibleCount","audiences"],"additionalProperties":false},"BusinessCampaignPoolCustomersListV2Response":{"type":"object","properties":{"data":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customerKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"type":"string"},"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"businessProfileKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"profileName":{"anyOf":[{"type":"string"},{"type":"null"}]},"profileUrl":{"type":"string"},"profileBusinessSummary":{"anyOf":[{"type":"string"},{"type":"null"}]},"source":{"type":"string","enum":["generated","manual","connected"]},"poolStatus":{"type":"string","enum":["active","retired"]},"retiredAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"forecastSeeded":{"type":"boolean"},"audiences":{"type":"array","items":{"type":"string"}},"systemAudiences":{"type":"array","items":{"type":"string"}},"userAudiences":{"type":"array","items":{"type":"string"}},"userAudienceIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"sources":{"type":"array","items":{"type":"string"}},"jobTitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"gender":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Gender"},"age":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Age"},"age.band":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Age band"},"language":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Language"},"location":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Location"},"market":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Market"},"areaType":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Area type"},"education":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Education"},"lifeStage":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Life stage"},"householdIncome":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Household income"},"householdIncome.band":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Income band"},"occupation":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Occupation"},"seniority":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Seniority"},"employer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Employer"},"companySize":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Company size"},"companySize.band":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Size band"},"annualRevenue":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Annual revenue"},"buyerType":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Buyer type"},"audience":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Audience"},"product":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Product"},"channel":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Channel"},"buyerRole":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Buyer role"},"intentStage":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Intent stage"},"job":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Job to be done"},"triggerType":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Trigger type"},"trigger":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Trigger"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"generationRunId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"latestDiscoveryOutcome":{"$ref":"#/components/schemas/DiscoveryLatestDiscoveryOutcome"},"audienceMemberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"createdBy":{"type":"string","enum":["system","user"]}},"required":["id","name","createdBy"],"additionalProperties":false}},"place":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"\"City, ST\"."},"ineligibleReason":{"anyOf":[{"type":"string","enum":["deleted","archived","other_profile","forecast_customer","not_store_customer","other_store","not_forecast_customer","connected_not_ready","outside_audience","unavailable"]},{"type":"null"}],"description":"Why the pick cannot take the customer; null when it can."}},"required":["id","customerKey","label","businessProfileId","businessProfileKey","profileName","profileUrl","profileBusinessSummary","source","poolStatus","retiredAt","forecastSeeded","audiences","systemAudiences","userAudiences","userAudienceIds","sources","jobTitle","gender","age","age.band","language","location","market","areaType","education","lifeStage","householdIncome","householdIncome.band","occupation","seniority","employer","companySize","companySize.band","annualRevenue","buyerType","audience","product","channel","buyerRole","intentStage","job","triggerType","trigger","createdAt","generationRunId","latestDiscoveryOutcome","audienceMemberships","place","ineligibleReason"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"totalCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"ineligibleCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Customers the search keeps that the pick cannot take, listed or not."},"selectedCustomerIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"audienceTypes":{"type":"array","items":{"type":"string","enum":["b2b","b2c","prosumer","mixed"]},"description":"The audience types of the customers this list draws from, each read as a Buyer type (b2c is B2C; b2b, prosumer and mixed are B2B); a column only another Buyer type carries is not a column."}},"required":["data","nextCursor","totalCount","ineligibleCount","selectedCustomerIds","audienceTypes"],"additionalProperties":false},"BusinessCampaignPoolCustomersListV3Response":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BusinessData"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"totalCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"ineligibleCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Customers the search keeps that the pick cannot take, listed or not."},"selectedCustomerIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"audienceTypes":{"type":"array","items":{"type":"string","enum":["b2b","b2c","prosumer","mixed"]},"description":"The audience types of the customers this list draws from, each read as a Buyer type (b2c is B2C; b2b, prosumer and mixed are B2B); a column only another Buyer type carries is not a column."}},"required":["data","nextCursor","totalCount","ineligibleCount","selectedCustomerIds","audienceTypes"],"additionalProperties":false},"BusinessCampaignPoolCustomersListV4Response":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BusinessData"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"totalCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"ineligibleCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Customers the search keeps that the pick cannot take, listed or not."},"selectedCustomerIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"audienceTypes":{"type":"array","items":{"type":"string","enum":["b2b","b2c","prosumer","mixed"]},"description":"The audience types of the customers this list draws from, each read as a Buyer type (b2c is B2C; b2b, prosumer and mixed are B2B); a column only another Buyer type carries is not a column."}},"required":["data","nextCursor","totalCount","ineligibleCount","selectedCustomerIds","audienceTypes"],"additionalProperties":false},"BusinessCampaignPoolCountsGetResponse":{"type":"object","properties":{"count":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["count"],"additionalProperties":false},"BusinessCampaignPoolCountsGetV2Response":{"type":"object","properties":{"count":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["count"],"additionalProperties":false},"BusinessCampaignCustomerSelectionsResolveResponse":{"type":"object","properties":{"selection":{"anyOf":[{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"explicit"},"customerIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},"required":["kind","customerIds"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"audience"},"audienceIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},"required":["kind","audienceIds"],"additionalProperties":false}]},{"type":"null"}],"description":"The targeting a launch takes; null is the profile's whole eligible pool."}},"required":["selection"],"additionalProperties":false},"BusinessCampaignCustomerSelectionsResolveV2Response":{"type":"object","properties":{"selection":{"anyOf":[{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"explicit"},"customerIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},"required":["kind","customerIds"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"audience"},"audienceIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},"required":["kind","audienceIds"],"additionalProperties":false}]},{"type":"null"}],"description":"The targeting a launch takes; null is the profile's whole eligible pool."}},"required":["selection"],"additionalProperties":false},"BusinessCommercialSchedulesGetResponse":{"type":"object","properties":{"profileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"profileName":{"anyOf":[{"type":"string"},{"type":"null"}]},"profileVersionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Pass as baseVersionId when updating."},"profileVersion":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"generatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"revenueLines":{"type":"array","items":{"type":"object","properties":{"revenueLineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revenueLineName":{"type":"string"},"schedule":{"$ref":"#/components/schemas/BusinessSchedule"},"scheduleStatus":{"type":"string","enum":["profile","missing","invalid"],"description":"`missing` and `invalid` lines have no usable schedule."},"scheduleRevision":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"reset":{"type":"boolean","description":"The revision returned the line to research's schedule."}},"required":["id","revision","reset"],"additionalProperties":false},{"type":"null"}],"description":"Pass its id as expectedRevisionId when updating the line."}},"required":["revenueLineId","revenueLineName","schedule","scheduleStatus","scheduleRevision"],"additionalProperties":false}}},"required":["profileId","profileName","profileVersionId","profileVersion","generatedAt","revenueLines"],"additionalProperties":false},"BusinessCommercialSchedulesUpdateRequest":{"type":"object","properties":{"profileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The business profile id."},"baseVersionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The profile version the lines were read from (profileVersionId)."},"lines":{"minItems":1,"maxItems":7,"type":"array","items":{"type":"object","properties":{"revenueLineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"schedule":{"anyOf":[{"$ref":"#/components/schemas/BusinessScheduleVariant"},{"type":"null"}],"description":"The line's new weekly schedule; null resets it to research's."},"expectedRevisionId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The id of the schedule revision the line was read with; null when it had none."}},"required":["revenueLineId","schedule","expectedRevisionId"],"additionalProperties":false}}},"required":["profileId","baseVersionId","lines"],"additionalProperties":false},"BusinessCommercialSchedulesUpdateResponse":{"type":"object","properties":{"changed":{"type":"boolean","description":"Whether any line took a new revision."},"lines":{"type":"array","items":{"type":"object","properties":{"revenueLineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"schedule":{"$ref":"#/components/schemas/BusinessSchedule"},"scheduleRevision":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"reset":{"type":"boolean","description":"The revision returned the line to research's schedule."}},"required":["id","revision","reset"],"additionalProperties":false},{"type":"null"}],"description":"Pass its id as expectedRevisionId when updating the line."}},"required":["revenueLineId","schedule","scheduleRevision"],"additionalProperties":false},"description":"Each requested line as stored."}},"required":["changed","lines"],"additionalProperties":false},"BusinessCrmConnectionsListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"provider":{"type":"string","enum":["hubspot","salesforce"]},"availability":{"type":"string","enum":["not_set_up","not_connected","connected","revoking"]},"availabilityUnknown":{"type":"boolean","const":true},"connectionId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"tenantLabel":{"anyOf":[{"type":"string"},{"type":"null"}]},"connectedByUserId":{"anyOf":[{"type":"string"},{"type":"null"}]},"connectedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"health":{"anyOf":[{"type":"string","enum":["healthy","degraded","needs_reconsent","reconnect_required"]},{"type":"null"}]},"healthReason":{"anyOf":[{"type":"string","enum":["grant_revoked","revocation_pending","provider_unavailable","provider_quota","source_stalled","scope_missing"]},{"type":"null"}]},"lastSuccessfulReadAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"counts":{"type":"object","properties":{"syncSources":{"type":"integer","minimum":0,"maximum":9007199254740991},"stalledSources":{"type":"integer","minimum":0,"maximum":9007199254740991},"followedContacts":{"type":"integer","minimum":0,"maximum":9007199254740991},"followLimit":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["syncSources","stalledSources","followedContacts","followLimit"],"additionalProperties":false}},"required":["provider","availability","connectionId","tenantLabel","connectedByUserId","connectedAt","health","healthReason","lastSuccessfulReadAt","counts"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"BusinessCrmConnectionActivitiesListResponse":{"type":"object","properties":{"data":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"kind":{"type":"string","enum":["connected","reconnected","disconnected","grant_lost","import_requested","import_committed","import_failed","import_unchanged","source_created","source_paused","source_resumed","source_retired","source_rescheduled","contacts_auto_followed","contacts_rebound","mapping_saved"]},"actor":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"user"},"userId":{"type":"string"}},"required":["kind","userId"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"system"}},"required":["kind"],"additionalProperties":false}]},"subject":{"type":"object","properties":{"importId":{"type":"string"},"sourceId":{"type":"string"},"mappingVersion":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"additionalProperties":false},"reasonCode":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["at","kind","actor","subject","reasonCode"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"BusinessCrmCollectionsGetResponse":{"type":"object","properties":{"collections":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["all","list","list_view"]},"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"type":"string"},"size":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]}},"required":["kind","id","label","size"],"additionalProperties":false}}},"required":["collections"],"additionalProperties":false},"BusinessCrmRecordsLoadResponse":{"type":"object","properties":{"properties":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"},"type":{"type":"string","enum":["enumeration","date","text","number","other"]},"options":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"label":{"type":"string"}},"required":["value","label"],"additionalProperties":false}},{"type":"null"}]},"relation":{"type":"string","enum":["self","company"]},"group":{"anyOf":[{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"},"order":{"type":"number"},"custom":{"type":"boolean"}},"required":["key","label","order","custom"],"additionalProperties":false},{"type":"null"}]},"custom":{"type":"boolean"},"tucked":{"anyOf":[{"type":"string","enum":["hidden","duplicate","record_key","consent","stage_history","not_on_layout"]},{"type":"null"}]},"role":{"anyOf":[{"type":"string","enum":["stage","created","updated"]},{"type":"null"}]},"family":{"anyOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["stage_entered","stage_exited"]},"stage":{"type":"string"}},"required":["kind","stage"],"additionalProperties":false},{"type":"null"}]},"suggested":{"type":"boolean"},"bookkeeping":{"type":"boolean"},"identity":{"type":"boolean"}},"required":["key","label","type","options","relation","group","custom","tucked","role","family","suggested","bookkeeping","identity"],"additionalProperties":false}},{"type":"null"}]},"rows":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"values":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}},"required":["id","values"],"additionalProperties":false}},"total":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"starts":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]}},"required":["properties","rows","total","nextCursor","starts"],"additionalProperties":false},"BusinessCrmTranscriptFieldsGetResponse":{"type":"object","properties":{"id":{"type":"string","enum":["hubspot","salesforce"]},"objectType":{"anyOf":[{"type":"string","enum":["calls","meetings"]},{"type":"null"}]},"fields":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"}},"required":["key","label"],"additionalProperties":false}},"available":{"type":"boolean"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","objectType","fields","available","reason"],"additionalProperties":false},"BusinessCrmContactsListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"bindingId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customerKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"type":"string"},"recordId":{"type":"string"},"provider":{"type":"string","enum":["hubspot","salesforce"]},"objectType":{"type":"string","enum":["contacts","leads"]},"status":{"type":"string","enum":["following","paused","unavailable","retired"]},"statusDetail":{"type":"object","properties":{"unavailableReason":{"anyOf":[{"type":"string","enum":["access_lost","connection_changed"]},{"type":"null"}]},"erasureReason":{"anyOf":[{"type":"string","enum":["member_forget","provider_deleted","provider_merged","provider_converted","organization_purge"]},{"type":"null"}]}},"required":["unavailableReason","erasureReason"],"additionalProperties":false},"sync":{"type":"object","properties":{"dirty":{"type":"boolean"},"dirtySince":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"lastCheckedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]}},"required":["dirty","dirtySince","lastCheckedAt"],"additionalProperties":false},"latestRefresh":{"anyOf":[{"type":"object","properties":{"outcome":{"type":"string","enum":["pending","published","unavailable","conflict","failed","refused","superseded"]},"mode":{"anyOf":[{"type":"string","enum":["identity","full","delta"]},{"type":"null"}]},"modeReason":{"anyOf":[{"type":"string","enum":["follow","rebuild","no_base","contract_changed","transcript_source_changed","base_unverifiable","evidence_retracted","delta"]},{"type":"null"}]},"settledAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"failureCode":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["outcome","mode","modeReason","settledAt","failureCode"],"additionalProperties":false},{"type":"null"}]},"waitingReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"version":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"evidenceCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"pinReviewCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"erasureDueAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"restorable":{"type":"boolean"},"mergedIntoBindingId":{"anyOf":[{"type":"string"},{"type":"null"}]},"mergedInto":{"anyOf":[{"type":"object","properties":{"name":{"type":"string"},"customerKey":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["name","customerKey"],"additionalProperties":false},{"type":"null"}]},"failureCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"source":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"scopeKind":{"type":"string","enum":["records","all","list","list_view","owner"]}},"required":["id","label","scopeKind"],"additionalProperties":false},{"type":"null"}]},"summaryMarkdown":{"anyOf":[{"type":"string"},{"type":"null"}]},"sourceUrl":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["bindingId","customerKey","name","recordId","provider","objectType","status","statusDetail","sync","latestRefresh","waitingReason","version","evidenceCount","pinReviewCount","erasureDueAt","restorable","mergedIntoBindingId","mergedInto","failureCode","source","summaryMarkdown","sourceUrl"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"integer","minimum":0,"maximum":9007199254740991},"followed":{"type":"object","properties":{"count":{"type":"integer","minimum":0,"maximum":9007199254740991},"limit":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["count","limit"],"additionalProperties":false}},"required":["data","nextCursor","total","followed"],"additionalProperties":false},"BusinessCrmContactsFollowRequest":{"type":"object","properties":{"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"objectType":{"type":"string","enum":["contacts","leads"]},"recordIds":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":40}},"historySince":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"sharedWithOrganization":{"type":"boolean","const":true},"hubspotTranscriptSource":{"type":"object","properties":{"kind":{"type":"string","enum":["text","transcript_id"]},"calls":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"meetings":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},"required":["kind","calls","meetings"],"additionalProperties":false}},"required":["connectionId","businessProfileId","objectType","recordIds","historySince","sharedWithOrganization"],"additionalProperties":false},"BusinessCrmContactsFollowResponse":{"type":"object","properties":{"bindingIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"skippedCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["bindingIds","skippedCount"],"additionalProperties":false},"BusinessCrmContactsRefreshRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The followed contact's id"},"mode":{"default":"changes","type":"string","enum":["changes","rebuild"]}},"required":["id"],"additionalProperties":false},"BusinessCrmContactsRefreshResponse":{"type":"object","properties":{"status":{"type":"string","enum":["following","paused","unavailable","retired","erased"]}},"required":["status"],"additionalProperties":false},"BusinessCrmContactsPauseRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The followed contact's id"}},"required":["id"],"additionalProperties":false},"BusinessCrmContactsPauseResponse":{"type":"object","properties":{"status":{"type":"string","enum":["following","paused","unavailable","retired","erased"]}},"required":["status"],"additionalProperties":false},"BusinessCrmContactsResumeRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The followed contact's id"}},"required":["id"],"additionalProperties":false},"BusinessCrmContactsResumeResponse":{"type":"object","properties":{"status":{"type":"string","enum":["following","paused","unavailable","retired","erased"]}},"required":["status"],"additionalProperties":false},"BusinessCrmContactsForgetRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The followed contact's id"}},"required":["id"],"additionalProperties":false},"BusinessCrmContactsForgetResponse":{"type":"object","properties":{"status":{"type":"string","const":"retired"},"erasureDueAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["status","erasureDueAt"],"additionalProperties":false},"BusinessCrmContactsRestoreRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The followed contact's id"}},"required":["id"],"additionalProperties":false},"BusinessCrmContactsRestoreResponse":{"type":"object","properties":{"status":{"type":"string","enum":["following","paused","unavailable","retired","erased"]}},"required":["status"],"additionalProperties":false},"BusinessCrmContactRefreshDisclosuresGetResponse":{"type":"object","properties":{"bindingId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"commercial":{"type":"string","const":"included"},"customerChargeUsd":{"type":"number","const":0},"syncOwnerUserId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"followed":{"type":"object","properties":{"count":{"type":"integer","minimum":0,"maximum":9007199254740991},"limit":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["count","limit"],"additionalProperties":false},"admission":{"type":"object","properties":{"state":{"type":"string","enum":["open","in_flight","queued","daily_limit","cost_settling","unavailable"]},"earliestAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]}},"required":["state","earliestAt"],"additionalProperties":false},"changes":{"type":"object","properties":{"lastUpdatedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"lastMode":{"anyOf":[{"type":"string","enum":["identity","full","delta"]},{"type":"null"}]},"lastModeReason":{"anyOf":[{"type":"string","enum":["follow","rebuild","no_base","contract_changed","transcript_source_changed","base_unverifiable","evidence_retracted","delta"]},{"type":"null"}]},"evidenceCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"knownNewEvidenceCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"lastCheckedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"lastFailureCode":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["lastUpdatedAt","lastMode","lastModeReason","evidenceCount","knownNewEvidenceCount","lastCheckedAt","lastFailureCode"],"additionalProperties":false},"actions":{"type":"object","properties":{"refresh":{"type":"object","properties":{"allowed":{"type":"boolean"},"reason":{"anyOf":[{"type":"string","enum":["not_following","connection_inactive","organization_inactive"]},{"type":"null"}]}},"required":["allowed","reason"],"additionalProperties":false},"rebuild":{"type":"object","properties":{"allowed":{"type":"boolean"},"reason":{"anyOf":[{"type":"string","enum":["not_following","connection_inactive","organization_inactive"]},{"type":"null"}]}},"required":["allowed","reason"],"additionalProperties":false}},"required":["refresh","rebuild"],"additionalProperties":false}},"required":["bindingId","commercial","customerChargeUsd","syncOwnerUserId","followed","admission","changes","actions"],"additionalProperties":false},"BusinessCrmMappingDraftsCreateV4Request":{"type":"object","properties":{"subject":{"$ref":"#/components/schemas/BusinessSubject"},"reuse":{"default":"saved","type":"string","enum":["saved","none"]},"baseVersionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"proposeKeys":{"maxItems":120,"type":"array","items":{"type":"string","minLength":1,"maxLength":255}},"proposalRunIds":{"maxItems":10,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"propose":{"default":true,"type":"boolean"}},"required":["subject"],"additionalProperties":false},"BusinessCrmMappingDraftsCreateV4Response":{"type":"object","properties":{"lineage":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"label":{"type":"string"},"currentVersion":{"$ref":"#/components/schemas/BusinessCurrentVersion"},"driftState":{"type":"string","enum":["none","review"]},"drift":{"$ref":"#/components/schemas/BusinessDrift"}},"required":["id","label","currentVersion","driftState","drift"],"additionalProperties":false},"base":{"anyOf":[{"type":"object","properties":{"versionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"lineageLabel":{"type":"string"},"matchedFieldCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"kind":{"type":"string","enum":["exact","overlap","chosen"]}},"required":["versionId","version","lineageLabel","matchedFieldCount","kind"],"additionalProperties":false},{"type":"null"}]},"baseCandidates":{"type":"array","items":{"type":"object","properties":{"versionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"lineageLabel":{"type":"string"},"matchedFieldCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["versionId","version","lineageLabel","matchedFieldCount","createdAt"],"additionalProperties":false}},"fields":{"type":"array","items":{"type":"object","properties":{"sourceKey":{"type":"string"},"label":{"type":"string"},"providerType":{"anyOf":[{"type":"string"},{"type":"null"}]},"valueType":{"type":"string","enum":["text","long_text","number","currency","percent","boolean","date","datetime","picklist","multi_picklist","reference","other"]},"custom":{"type":"boolean"},"availability":{"type":"string","enum":["proposable","manual_only","locked"]},"lock":{"anyOf":[{"type":"object","properties":{"reason":{"type":"string","enum":["identity","identifier","regulated","protected","unsupported_type"]},"rule":{"type":"string"}},"required":["reason","rule"],"additionalProperties":false},{"type":"null"}]},"header":{"type":"string"},"samples":{"type":"array","items":{"type":"string"}},"fill":{"anyOf":[{"type":"object","properties":{"filled":{"type":"integer","minimum":0,"maximum":9007199254740991},"sampled":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["filled","sampled"],"additionalProperties":false},{"type":"null"}]},"proposal":{"type":"object","properties":{"disposition":{"type":"string","enum":["mapped","not_imported","rejected"]},"target":{"anyOf":[{"type":"string","enum":["age","language","location","market","areaType","education","lifeStage","household","householdIncome","jobTitle","occupation","seniority","employer","yearsInRole","companySize","annualRevenue","audience","product","channel","buyerRole","stakeholders","intentStage","budget","constraints","job","situation","triggerType","trigger","functionalNeed","emotionalNeed","socialNeed","desiredOutcome","labels","website","industry","lifecycle_stage","spend","purchase_frequency","tier","notes","context","public_figure_context","department","lead_status","country_code"]},{"type":"null"}]},"rejectedCategory":{"anyOf":[{"type":"string","enum":["identifier","regulated","protected","unmappable"]},{"type":"null"}]},"decider":{"type":"string","enum":["rail","model","human","product_default"]},"railRule":{"anyOf":[{"type":"string"},{"type":"null"}]},"modelRunId":{"anyOf":[{"type":"string"},{"type":"null"}]},"decidedByUserId":{"anyOf":[{"type":"string"},{"type":"null"}]},"inheritedFromVersionId":{"anyOf":[{"type":"string"},{"type":"null"}]},"inheritedFromVersion":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["id","version"],"additionalProperties":false},{"type":"null"}]}},"required":["disposition","target","rejectedCategory","decider","railRule","modelRunId","decidedByUserId","inheritedFromVersionId","inheritedFromVersion"],"additionalProperties":false},"needsProposal":{"type":"boolean"}},"required":["sourceKey","label","providerType","valueType","custom","availability","lock","header","samples","fill","proposal","needsProposal"],"additionalProperties":false}},"conflicts":{"type":"array","items":{"type":"object","properties":{"target":{"type":"string","enum":["age","language","location","market","areaType","education","lifeStage","household","householdIncome","jobTitle","occupation","seniority","employer","yearsInRole","companySize","annualRevenue","audience","product","channel","buyerRole","stakeholders","intentStage","budget","constraints","job","situation","triggerType","trigger","functionalNeed","emotionalNeed","socialNeed","desiredOutcome","labels","website","industry","lifecycle_stage","spend","purchase_frequency","tier","notes","context","public_figure_context","department","lead_status","country_code"]},"sourceKeys":{"type":"array","items":{"type":"string"}}},"required":["target","sourceKeys"],"additionalProperties":false}},"proposalRunIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"omittedProposalCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"count":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"samplesTruncated":{"type":"boolean"},"followedContactCount":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]}},"required":["lineage","base","baseCandidates","fields","conflicts","proposalRunIds","omittedProposalCount","count","samplesTruncated","followedContactCount"],"additionalProperties":false},"BusinessCrmMappingPreviewsCreateV3Request":{"type":"object","properties":{"mode":{"type":"string","const":"audience"},"rows":{"maxItems":5,"type":"array","items":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":200},"additionalProperties":{"type":"string","maxLength":4000}}},"mapping":{"maxItems":120,"type":"array","items":{"type":"object","properties":{"header":{"type":"string","minLength":1,"maxLength":200},"target":{"type":"string","enum":["age","language","location","market","areaType","education","lifeStage","household","householdIncome","jobTitle","occupation","seniority","employer","yearsInRole","companySize","annualRevenue","audience","product","channel","buyerRole","stakeholders","intentStage","budget","constraints","job","situation","triggerType","trigger","functionalNeed","emotionalNeed","socialNeed","desiredOutcome","labels","website","industry","lifecycle_stage","spend","purchase_frequency","tier","notes"]}},"required":["header","target"],"additionalProperties":false}}},"required":["mode","rows","mapping"],"additionalProperties":false},"BusinessCrmMappingPreviewsCreateV3Response":{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","propertyNames":{"type":"string","enum":["age","language","location","market","areaType","education","lifeStage","household","householdIncome","jobTitle","occupation","seniority","employer","yearsInRole","companySize","annualRevenue","audience","product","channel","buyerRole","stakeholders","intentStage","budget","constraints","job","situation","triggerType","trigger","functionalNeed","emotionalNeed","socialNeed","desiredOutcome","labels","website","industry","lifecycle_stage","spend","purchase_frequency","tier","notes"]},"additionalProperties":{"type":"object","properties":{"value":{"anyOf":[{"type":"string"},{"type":"null"}]},"note":{"type":"string","enum":["summarized_during_processing","dropped_possible_identifier","not_read"]}},"required":["value"],"additionalProperties":false}}},"droppedCellCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["rows","droppedCellCount"],"additionalProperties":false},"BusinessCrmMappingVersionsCreateV2Request":{"type":"object","properties":{"subject":{"$ref":"#/components/schemas/BusinessSubject"},"parentVersionId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"baseVersionId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"reuse":{"default":"saved","type":"string","enum":["saved","none"]},"proposalRunIds":{"maxItems":10,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"choices":{"maxItems":5000,"type":"array","items":{"oneOf":[{"type":"object","properties":{"sourceKey":{"type":"string","minLength":1,"maxLength":255},"kind":{"type":"string","const":"accept"}},"required":["sourceKey","kind"],"additionalProperties":false},{"type":"object","properties":{"sourceKey":{"type":"string","minLength":1,"maxLength":255},"kind":{"type":"string","const":"map"},"target":{"type":"string","enum":["age","language","location","market","areaType","education","lifeStage","household","householdIncome","jobTitle","occupation","seniority","employer","yearsInRole","companySize","annualRevenue","audience","product","channel","buyerRole","stakeholders","intentStage","budget","constraints","job","situation","triggerType","trigger","functionalNeed","emotionalNeed","socialNeed","desiredOutcome","labels","website","industry","lifecycle_stage","spend","purchase_frequency","tier","notes","context","public_figure_context","department","lead_status","country_code"]}},"required":["sourceKey","kind","target"],"additionalProperties":false},{"type":"object","properties":{"sourceKey":{"type":"string","minLength":1,"maxLength":255},"kind":{"type":"string","const":"skip"}},"required":["sourceKey","kind"],"additionalProperties":false}]}},"label":{"type":"string","minLength":1,"maxLength":200},"holdConflicts":{"type":"boolean"},"pinSyncSourceId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["subject","parentVersionId","proposalRunIds","choices"],"additionalProperties":false},"BusinessCrmMappingVersionsCreateV2Response":{"type":"object","properties":{"version":{"$ref":"#/components/schemas/BusinessCurrentVersionVariant"},"created":{"type":"boolean"},"lineage":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"driftState":{"type":"string","enum":["none","review"]}},"required":["id","driftState"],"additionalProperties":false}},"required":["version","created","lineage"],"additionalProperties":false},"BusinessCrmMappingVersionsGetV4Response":{"type":"object","properties":{"version":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lineageId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"createdBy":{"anyOf":[{"type":"object","properties":{"userId":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["userId","name"],"additionalProperties":false},{"type":"null"}]},"createdVia":{"type":"string","enum":["member","operator","bootstrap"]},"fieldCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"mappedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"humanDecisionCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"decisionDigest":{"type":"string"},"declaredInputDigest":{"anyOf":[{"type":"string"},{"type":"null"}]},"lineage":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"label":{"type":"string"},"subjectKind":{"type":"string","enum":["connector","csv"]},"mode":{"type":"string","enum":["audience","contacts"]},"provider":{"anyOf":[{"type":"string","enum":["hubspot","salesforce"]},{"type":"null"}]},"externalTenantId":{"anyOf":[{"type":"string"},{"type":"null"}]},"objectType":{"anyOf":[{"type":"string","enum":["contacts","companies","leads"]},{"type":"null"}]}},"required":["id","label","subjectKind","mode","provider","externalTenantId","objectType"],"additionalProperties":false},"fieldSnapshotDigest":{"type":"string"},"fields":{"type":"array","items":{"type":"object","properties":{"sourceKey":{"type":"string"},"label":{"type":"string"},"providerType":{"anyOf":[{"type":"string"},{"type":"null"}]},"valueType":{"type":"string","enum":["text","long_text","number","currency","percent","boolean","date","datetime","picklist","multi_picklist","reference","other"]},"custom":{"type":"boolean"},"availability":{"type":"string","enum":["proposable","manual_only","locked"]},"lock":{"anyOf":[{"type":"object","properties":{"reason":{"type":"string","enum":["identity","identifier","regulated","protected","unsupported_type"]},"rule":{"type":"string"}},"required":["reason","rule"],"additionalProperties":false},{"type":"null"}]},"ordinal":{"type":"integer","minimum":0,"maximum":9007199254740991},"decision":{"$ref":"#/components/schemas/BusinessDecision"},"decidedByName":{"anyOf":[{"type":"string"},{"type":"null"}]},"inheritedFromVersion":{"anyOf":[{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},{"type":"null"}]}},"required":["sourceKey","label","providerType","valueType","custom","availability","lock","ordinal","decision","decidedByName","inheritedFromVersion"],"additionalProperties":false}}},"required":["id","lineageId","version","createdAt","createdBy","createdVia","fieldCount","mappedCount","humanDecisionCount","decisionDigest","declaredInputDigest","lineage","fieldSnapshotDigest","fields"],"additionalProperties":false},"diff":{"anyOf":[{"type":"object","properties":{"added":{"type":"array","items":{"type":"object","properties":{"sourceKey":{"type":"string"},"label":{"type":"string"}},"required":["sourceKey","label"],"additionalProperties":false}},"removed":{"type":"array","items":{"type":"object","properties":{"sourceKey":{"type":"string"},"label":{"type":"string"}},"required":["sourceKey","label"],"additionalProperties":false}},"changed":{"type":"array","items":{"type":"object","properties":{"sourceKey":{"type":"string"},"label":{"type":"string"},"from":{"$ref":"#/components/schemas/BusinessDecision"},"to":{"$ref":"#/components/schemas/BusinessDecision"}},"required":["sourceKey","label","from","to"],"additionalProperties":false}}},"required":["added","removed","changed"],"additionalProperties":false},{"type":"null"}]}},"required":["version","diff"],"additionalProperties":false},"BusinessCrmMappingLineagesGetResponse":{"type":"object","properties":{"lineage":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"label":{"type":"string"},"subjectKind":{"type":"string","enum":["connector","csv"]},"mode":{"type":"string","enum":["audience","contacts"]},"provider":{"anyOf":[{"type":"string","enum":["hubspot","salesforce"]},{"type":"null"}]},"externalTenantId":{"anyOf":[{"type":"string"},{"type":"null"}]},"objectType":{"anyOf":[{"type":"string","enum":["contacts","companies","leads"]},{"type":"null"}]},"currentVersion":{"$ref":"#/components/schemas/BusinessCurrentVersion"},"driftState":{"type":"string","enum":["none","review"]},"drift":{"$ref":"#/components/schemas/BusinessDrift"},"observedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["id","label","subjectKind","mode","provider","externalTenantId","objectType","currentVersion","driftState","drift","observedAt","updatedAt"],"additionalProperties":false},"versions":{"type":"array","items":{"$ref":"#/components/schemas/BusinessCurrentVersionVariant"}}},"required":["lineage","versions"],"additionalProperties":false},"BusinessCrmSourcesListResponse":{"type":"object","properties":{"data":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["csv_upload","connector_import","audience_sync","contacts_segment"]},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"provider":{"anyOf":[{"type":"string","enum":["hubspot","salesforce"]},{"type":"null"}]},"objectType":{"anyOf":[{"type":"string","enum":["contacts","companies","leads"]},{"type":"null"}]},"scope":{"type":"object","properties":{"kind":{"type":"string","enum":["file","all","list","list_view","owner"]},"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["kind","id","label"],"additionalProperties":false},"mode":{"type":"string","enum":["contacts","audience"]},"businessProfileId":{"anyOf":[{"type":"string"},{"type":"null"}]},"uploadId":{"anyOf":[{"type":"string"},{"type":"null"}]},"generationProfileId":{"anyOf":[{"type":"string"},{"type":"null"}]},"originImportId":{"anyOf":[{"type":"string"},{"type":"null"}]},"currentVersion":{"anyOf":[{"type":"object","properties":{"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"uploadId":{"type":"string"},"generationProfileId":{"type":"string"},"rows":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]}},"required":["version","uploadId","generationProfileId","rows"],"additionalProperties":false},{"type":"null"}]},"runs":{"anyOf":[{"type":"object","properties":{"total":{"type":"integer","minimum":0,"maximum":9007199254740991},"latest":{"type":"array","items":{"type":"object","properties":{"importId":{"type":"string"},"at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"kind":{"type":"string","enum":["import","update"]},"status":{"type":"string","enum":["queued","reading","processing","ready","unchanged","failed"]},"failure":{"anyOf":[{"type":"object","properties":{"code":{"type":"string"},"retryAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]}},"required":["code","retryAt"],"additionalProperties":false},{"type":"null"}]},"rows":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"changedRows":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"removedRows":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"version":{"anyOf":[{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},{"type":"null"}]},"uploadId":{"anyOf":[{"type":"string"},{"type":"null"}]},"generationProfileId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["importId","at","kind","status","failure","rows","changedRows","removedRows","version","uploadId","generationProfileId"],"additionalProperties":false}}},"required":["total","latest"],"additionalProperties":false},{"type":"null"}]},"autoFollow":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"narrowed":{"type":"boolean"},"rows":{"anyOf":[{"type":"object","properties":{"used":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"found":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]}},"required":["used","found"],"additionalProperties":false},{"type":"null"}]},"status":{"type":"string","enum":["queued","reading","processing","ready","unchanged","failed","active","paused"]},"failure":{"anyOf":[{"type":"object","properties":{"code":{"type":"string"},"retryAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]}},"required":["code","retryAt"],"additionalProperties":false},{"type":"null"}]},"retryWindow":{"anyOf":[{"type":"object","properties":{"until":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"expired":{"type":"boolean"}},"required":["until","expired"],"additionalProperties":false},{"type":"null"}]},"lastSyncedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"nextSyncAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"cadence":{"anyOf":[{"type":"string","enum":["daily","weekly","monthly"]},{"type":"null"}]},"followed":{"anyOf":[{"type":"object","properties":{"count":{"type":"integer","minimum":0,"maximum":9007199254740991},"blockedReason":{"anyOf":[{"type":"string","enum":["follow_cap","needs_reconsent"]},{"type":"null"}]}},"required":["count","blockedReason"],"additionalProperties":false},{"type":"null"}]},"mapping":{"anyOf":[{"type":"object","properties":{"lineageId":{"type":"string"},"versionId":{"type":"string"},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"mappedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"fieldCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"driftState":{"type":"string","enum":["none","review"]},"mappedFieldAffected":{"type":"boolean"}},"required":["lineageId","versionId","version","mappedCount","fieldCount","driftState","mappedFieldAffected"],"additionalProperties":false},{"type":"null"}]},"unavailableMappedFieldCount":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"customers":{"anyOf":[{"type":"object","properties":{"count":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"runId":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","enum":["waiting","running","succeeded","failed","cancelled","refused"]},"refusal":{"anyOf":[{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false},{"type":"null"}]}},"required":["count","runId","status","refusal"],"additionalProperties":false},{"type":"null"}]},"createdByUserId":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"archivedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]}},"required":["kind","id","name","provider","objectType","scope","mode","businessProfileId","uploadId","generationProfileId","originImportId","currentVersion","runs","autoFollow","narrowed","rows","status","failure","retryWindow","lastSyncedAt","nextSyncAt","cadence","followed","mapping","unavailableMappedFieldCount","customers","createdByUserId","createdAt","archivedAt"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["data","nextCursor","total"],"additionalProperties":false},"BusinessCrmSyncSourcesCreateRequest":{"type":"object","properties":{"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"mode":{"type":"string","enum":["contacts","audience"]},"objectType":{"type":"string","enum":["contacts","companies","leads"]},"scope":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"all"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","enum":["list","list_view","owner"]},"id":{"type":"string","minLength":1,"maxLength":200},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["kind","id","label"],"additionalProperties":false}]},"autoFollow":{"type":"boolean"},"historySince":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"hubspotTranscriptSource":{"type":"object","properties":{"kind":{"type":"string","enum":["text","transcript_id"]},"calls":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"meetings":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},"required":["kind","calls","meetings"],"additionalProperties":false},"audience":{"type":"object","properties":{"importId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"cadence":{"type":"string","enum":["monthly","weekly"]}},"required":["importId","cadence"],"additionalProperties":false}},"required":["connectionId","businessProfileId","mode","objectType","scope","autoFollow"],"additionalProperties":false},"BusinessCrmSyncSourcesCreateResponse":{"type":"object","properties":{"sourceId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"status":{"type":"string","enum":["active","paused","retired"]},"created":{"type":"boolean"},"campaignId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"cadence":{"anyOf":[{"type":"string","enum":["daily","weekly","monthly"]},{"type":"null"}]},"nextSyncAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]}},"required":["sourceId","status","created","campaignId","cadence","nextSyncAt"],"additionalProperties":false},"BusinessCrmSyncSourcesUpdateRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The sync source's id"},"change":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"pause"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"resume"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"retire"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"auto_follow"},"value":{"type":"boolean"}},"required":["kind","value"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"cadence"},"cadence":{"type":"string","enum":["monthly","weekly"]}},"required":["kind","cadence"],"additionalProperties":false}]}},"required":["id","change"],"additionalProperties":false},"BusinessCrmSyncSourcesUpdateResponse":{"type":"object","properties":{"status":{"type":"string","enum":["active","paused","retired"]},"autoFollow":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"cadence":{"anyOf":[{"type":"string","enum":["daily","weekly","monthly"]},{"type":"null"}]},"nextSyncAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]}},"required":["status","autoFollow","cadence","nextSyncAt"],"additionalProperties":false},"BusinessCrmSyncSourcesSyncRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The sync source's id"}},"required":["id"],"additionalProperties":false},"BusinessCrmSyncSourcesSyncResponse":{"type":"object","properties":{"status":{"type":"string","enum":["active","paused","retired"]},"sync":{"type":"string","const":"queued"},"importId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["status","sync","importId"],"additionalProperties":false},"BusinessCrmImportsCreateRequest":{"type":"object","properties":{"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":200},"objectType":{"type":"string","enum":["contacts","companies","leads"]},"collection":{"type":"object","properties":{"kind":{"type":"string","enum":["all","list","list_view"]},"id":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["kind","id","label"],"additionalProperties":false},"mappingVersionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"selection":{"type":"object","properties":{"kind":{"type":"string","const":"records"},"ids":{"minItems":1,"maxItems":20000,"type":"array","items":{"type":"string","pattern":"^[A-Za-z0-9]{1,40}$"}}},"required":["kind","ids"],"additionalProperties":false},"keepInSync":{"type":"object","properties":{"cadence":{"type":"string","enum":["monthly","weekly"]}},"required":["cadence"],"additionalProperties":false},"customerTargetCount":{"type":"integer","minimum":1,"maximum":5000}},"required":["connectionId","businessProfileId","name","objectType","collection","mappingVersionId"],"additionalProperties":false},"BusinessCrmImportsCreateResponse":{"type":"object","properties":{"importId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"status":{"type":"string","enum":["requested","pulling","committed","failed","unchanged"]}},"required":["importId","status"],"additionalProperties":false},"BusinessCrmImportsUpdateRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The kept list's first import id"},"name":{"type":"string","minLength":1,"maxLength":200,"description":"The kept list's new name"}},"required":["id","name"],"additionalProperties":false},"BusinessCrmImportsUpdateResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},"BusinessCrmImportsDeleteRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The kept list's first import id"}},"required":["id"],"additionalProperties":false},"BusinessCrmImportsDeleteResponse":{"type":"object","properties":{"deletedGenerationProfiles":{"type":"integer","minimum":0,"maximum":9007199254740991},"deletedCustomers":{"type":"integer","minimum":0,"maximum":9007199254740991},"retiredCustomers":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["deletedGenerationProfiles","deletedCustomers","retiredCustomers"],"additionalProperties":false},"BusinessCrmImportsArchiveRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The kept list's first import id"}},"required":["id"],"additionalProperties":false},"BusinessCrmImportsArchiveResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"archivedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"changed":{"type":"boolean"}},"required":["id","archivedAt","changed"],"additionalProperties":false},"BusinessCrmImportsRestoreRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The kept list's first import id"}},"required":["id"],"additionalProperties":false},"BusinessCrmImportsRestoreResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"archivedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"changed":{"type":"boolean"}},"required":["id","archivedAt","changed"],"additionalProperties":false},"BusinessCrmUploadsCreateRequest":{"type":"object","properties":{"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"mappingVersionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":120},"rows":{"maxItems":20000,"type":"array","items":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":200},"additionalProperties":{"type":"string","maxLength":4000}}},"customerTargetCount":{"type":"integer","minimum":1,"maximum":5000}},"required":["businessProfileId","mappingVersionId","name","rows"],"additionalProperties":false},"BusinessCrmUploadsCreateResponse":{"type":"object","properties":{"uploadId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"runId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"rowCount":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"droppedCellCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["uploadId","runId","rowCount","droppedCellCount"],"additionalProperties":false},"BusinessCrmUploadsUpdateRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The upload's id"},"name":{"description":"The upload's new name","type":"string","minLength":1,"maxLength":120}},"required":["id","name"],"additionalProperties":false},"BusinessCrmUploadsUpdateResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},"BusinessCrmUploadsDeleteRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The upload's id"}},"required":["id"],"additionalProperties":false},"BusinessCrmUploadsDeleteResponse":{"type":"object","properties":{"deletedGenerationProfiles":{"type":"integer","minimum":0,"maximum":9007199254740991},"deletedCustomers":{"type":"integer","minimum":0,"maximum":9007199254740991},"retiredCustomers":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["deletedGenerationProfiles","deletedCustomers","retiredCustomers"],"additionalProperties":false},"BusinessCrmUploadsArchiveRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The upload's id"}},"required":["id"],"additionalProperties":false},"BusinessCrmUploadsArchiveResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"archivedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"changed":{"type":"boolean"}},"required":["id","archivedAt","changed"],"additionalProperties":false},"BusinessCrmUploadsRestoreRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The upload's id"}},"required":["id"],"additionalProperties":false},"BusinessCrmUploadsRestoreResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"archivedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"changed":{"type":"boolean"}},"required":["id","archivedAt","changed"],"additionalProperties":false},"BusinessCrmUploadsRetryRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The failed upload's id"}},"required":["id"],"additionalProperties":false},"BusinessCrmUploadsRetryResponse":{"type":"object","properties":{"runId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["runId"],"additionalProperties":false},"ReportsDatasetsListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"`<product>.<name>`, the definition's `dataset`."},"product":{"type":"string","enum":["discovery","experience","research"],"description":"The product whose results a report reads."},"label":{"type":"string"},"description":{"type":"string"},"grain":{"type":"string","enum":["aggregate","records"],"description":"`aggregate`: rows and columns grouped by dimensions, each cell its measures. `records`: one row per interaction, the dimensions as its fields."},"scope":{"type":"string","enum":["window","range"],"description":"`window`: the trailing 30-day results window ending on the as-of day the date range chooses. `range`: the range itself."},"allCampaigns":{"type":"boolean","description":"Whether a report may read every campaign of the product at once (`scope.campaignId` null), each campaign read as its own dashboard reads it and pooled."},"dimensions":{"type":"array","prefixItems":[{"$ref":"#/components/schemas/ReportsDimensions"}],"items":{"$ref":"#/components/schemas/ReportsDimensions"}},"measures":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"A key a report definition names."},"label":{"type":"string"},"format":{"type":"string","enum":["count","percent","stars","score","mean"],"description":"Only a count can be shown as a share of its row, column or total."},"precision":{"type":"string","enum":["share","derived","none"],"description":"`share`: a margin over the cell's customers. `derived`: a verdict from its customers. `none`: no precision."},"description":{"type":"string"}},"required":["key","label","format","precision","description"],"additionalProperties":false}},"limits":{"type":"object","properties":{"rows":{"type":"integer","minimum":0,"maximum":9007199254740991},"columns":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["rows","columns"],"additionalProperties":false,"description":"How many row and column dimensions a report may group by."},"exclusive":{"description":"Sets of dimensions a report groups by at most one of.","type":"array","items":{"type":"array","items":{"type":"string","description":"A key a report definition names."}}},"filterExcludes":{"description":"A report that filters by any of `filters` groups by none of `grouping`.","type":"array","items":{"type":"object","properties":{"filters":{"type":"array","items":{"type":"string","description":"A key a report definition names."}},"grouping":{"type":"array","items":{"type":"string","description":"A key a report definition names."}}},"required":["filters","grouping"],"additionalProperties":false}},"compare":{"type":"boolean","description":"Whether a report may compare with the window 30 days earlier."},"drill":{"description":"The records dataset a cell opens, filtered to its values.","type":"string"},"defaults":{"type":"object","properties":{"rows":{"type":"array","items":{"type":"string","description":"A key a report definition names."}},"columns":{"type":"array","items":{"type":"string","description":"A key a report definition names."}},"measures":{"type":"array","items":{"type":"string","description":"A key a report definition names."}}},"required":["rows","columns","measures"],"additionalProperties":false,"description":"What a new report of the dataset opens on."}},"required":["id","product","label","description","grain","scope","allCampaigns","dimensions","measures","limits","compare","defaults"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"ReportsReportTablesGetResponse":{"type":"object","properties":{"table":{"anyOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"},"grain":{"type":"string","const":"aggregate"},"span":{"$ref":"#/components/schemas/ReportsSpan"},"rowDimensions":{"readOnly":true,"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"}},"required":["key","label"],"additionalProperties":false}},"columnDimensions":{"readOnly":true,"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"}},"required":["key","label"],"additionalProperties":false}},"columns":{"readOnly":true,"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"measure":{"type":"string"},"measureLabel":{"type":"string"},"format":{"type":"string","enum":["count","percent","stars","score","mean"]},"showAs":{"type":"string","enum":["value","row","column","total"]},"values":{"readOnly":true,"description":"Each column dimension's value; empty on a total.","type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"},"link":{"description":"The product's own page that answers this value, and what it opens.","type":"object","properties":{"href":{"type":"string","pattern":"^\\/app\\/.*"},"label":{"type":"string","minLength":1}},"required":["href","label"],"additionalProperties":false},"filterable":{"description":"A value no filter on its dimension keeps (the campaign's own brand among the brands named): its row opens no records.","type":"boolean","const":false}},"required":["key","label"],"additionalProperties":false}},"total":{"type":"boolean"}},"required":["id","measure","measureLabel","format","showAs","values","total"],"additionalProperties":false}},"rows":{"readOnly":true,"description":"This page's rows.","type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"values":{"readOnly":true,"description":"Each row dimension's value, outermost first.","type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"},"link":{"description":"The product's own page that answers this value, and what it opens.","type":"object","properties":{"href":{"type":"string","pattern":"^\\/app\\/.*"},"label":{"type":"string","minLength":1}},"required":["href","label"],"additionalProperties":false},"filterable":{"description":"A value no filter on its dimension keeps (the campaign's own brand among the brands named): its row opens no records.","type":"boolean","const":false}},"required":["key","label"],"additionalProperties":false}},"cells":{"$ref":"#/components/schemas/ReportsCells"},"drill":{"anyOf":[{"type":"object","properties":{"filters":{"readOnly":true,"type":"array","items":{"type":"object","properties":{"dimension":{"type":"string"},"values":{"readOnly":true,"type":"array","items":{"type":"string"}}},"required":["dimension","values"],"additionalProperties":false}},"dateRange":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The records' date range, for a row read as of one day; null keeps the report's."}},"required":["filters","dateRange"],"additionalProperties":false},{"type":"null"}],"description":"What opens this row's records in the dataset's `drill`: the report's filters and the row's own values; null where the dataset drills nowhere."}},"required":["id","values","cells","drill"],"additionalProperties":false}},"total":{"type":"object","properties":{"id":{"type":"string"},"values":{"readOnly":true,"description":"Each row dimension's value, outermost first.","type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"},"link":{"description":"The product's own page that answers this value, and what it opens.","type":"object","properties":{"href":{"type":"string","pattern":"^\\/app\\/.*"},"label":{"type":"string","minLength":1}},"required":["href","label"],"additionalProperties":false},"filterable":{"description":"A value no filter on its dimension keeps (the campaign's own brand among the brands named): its row opens no records.","type":"boolean","const":false}},"required":["key","label"],"additionalProperties":false}},"cells":{"$ref":"#/components/schemas/ReportsCells"},"drill":{"anyOf":[{"type":"object","properties":{"filters":{"readOnly":true,"type":"array","items":{"type":"object","properties":{"dimension":{"type":"string"},"values":{"readOnly":true,"type":"array","items":{"type":"string"}}},"required":["dimension","values"],"additionalProperties":false}},"dateRange":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The records' date range, for a row read as of one day; null keeps the report's."}},"required":["filters","dateRange"],"additionalProperties":false},{"type":"null"}],"description":"What opens this row's records in the dataset's `drill`: the report's filters and the row's own values; null where the dataset drills nowhere."}},"required":["id","values","cells","drill"],"additionalProperties":false,"description":"The grand total row: each column's total over every row."},"rowCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Every row the table holds across its pages."},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"chart":{"anyOf":[{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"},"x":{"anyOf":[{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"},"time":{"type":"boolean"}},"required":["key","label","time"],"additionalProperties":false},{"type":"null"}],"description":"The dimension along x (`time`: its days, in time), or null: one category, `all`, every row's."},"categoryCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Every category the report holds along x."},"categories":{"readOnly":true,"description":"The categories drawn, in the chart's order: every day in time, every part of a pie, or the first `chart.topN` in the report's sorted rows (x on Rows) or by the product's column total, largest first (x on Columns). No `Other` stands for the rest.","maxItems":1000,"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"},"link":{"description":"The product's own page that answers this value, and what it opens.","type":"object","properties":{"href":{"type":"string","pattern":"^\\/app\\/.*"},"label":{"type":"string","minLength":1}},"required":["href","label"],"additionalProperties":false},"filterable":{"description":"A value no filter on its dimension keeps (the campaign's own brand among the brands named): its row opens no records.","type":"boolean","const":false}},"required":["key","label"],"additionalProperties":false}},"seriesFrom":{"type":"string","enum":["columns","rows","values"],"description":"Where the series come from: the dimension on Columns or Rows, or the values."},"seriesCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Every series the report holds: the series dimension's values, or the values on the drawn value's scale."},"series":{"readOnly":true,"description":"The series drawn, in the product's value order: the dimension's first values by the product's column totals, by their value on the last day, or by where each first falls in the report's order; or the values.","maxItems":5,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The series dimension's value key, or the value's column id."},"label":{"type":"string"},"column":{"type":"object","properties":{"id":{"type":"string"},"measure":{"type":"string"},"measureLabel":{"type":"string"},"format":{"type":"string","enum":["count","percent","stars","score","mean"]},"showAs":{"type":"string","enum":["value","row","column","total"]},"values":{"readOnly":true,"description":"Each column dimension's value; empty on a total.","type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"},"link":{"description":"The product's own page that answers this value, and what it opens.","type":"object","properties":{"href":{"type":"string","pattern":"^\\/app\\/.*"},"label":{"type":"string","minLength":1}},"required":["href","label"],"additionalProperties":false},"filterable":{"description":"A value no filter on its dimension keeps (the campaign's own brand among the brands named): its row opens no records.","type":"boolean","const":false}},"required":["key","label"],"additionalProperties":false}},"total":{"type":"boolean"}},"required":["id","measure","measureLabel","format","showAs","values","total"],"additionalProperties":false,"description":"The table column whose measure, format and show-as the series' points take."}},"required":["id","label","column"],"additionalProperties":false}},"points":{"readOnly":true,"description":"By category, then series: the table's own cell at each; a pie's, each part's share of the total (as a `% of total` column shows it).","type":"array","items":{"$ref":"#/components/schemas/ReportsPointsItem"}},"categoryTotals":{"anyOf":[{"$ref":"#/components/schemas/ReportsPointsItem"},{"type":"null"}],"description":"For a stacked chart, each category's total over the series, the product's own cell; null when nothing stacks."},"total":{"type":"object","properties":{"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The value as the report shows it: itself, or its share (0-100) of its row, column or total."},"precision":{"$ref":"#/components/schemas/ReportsPrecision"},"earlier":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The value over the window 30 days earlier, when the report compares."}},"required":["value","precision","earlier"],"additionalProperties":false,"description":"The table's grand total of the value drawn."}},"required":["status","x","categoryCount","categories","seriesFrom","seriesCount","series","points","categoryTotals","total"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"refused"},"reason":{"type":"string","enum":["too-many-days","too-many-parts","parts-exceed-whole"],"description":"More days than a chart draws (choose a shorter date range), a pie of more parts than it draws, or a pie or stack whose parts add up to more than the product's own whole, as overlapping parts of a distinct count do (draw bars side by side)."},"count":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Every category the report holds along x."},"max":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The most categories this chart draws."}},"required":["status","reason","count","max"],"additionalProperties":false}],"description":"The report's chart: the table's own cells, never a figure of its own; or why the data cannot draw it, beside the table."},{"type":"null"}],"description":"The report's chart, when its definition draws one (`chart` not null)."}},"required":["status","grain","span","rowDimensions","columnDimensions","columns","rows","total","rowCount","nextCursor","chart"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"ready"},"grain":{"type":"string","const":"records"},"span":{"$ref":"#/components/schemas/ReportsSpan"},"fields":{"readOnly":true,"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"}},"required":["key","label"],"additionalProperties":false}},"rows":{"readOnly":true,"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"values":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}]}},"href":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The product page that shows the interaction."}},"required":["id","values","href"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["status","grain","span","fields","rows","nextCursor"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"no-results"},"span":{"anyOf":[{"$ref":"#/components/schemas/ReportsSpan"},{"type":"null"}]}},"required":["status","span"],"additionalProperties":false,"description":"The campaign holds no results in this scope."}]}},"required":["table"],"additionalProperties":false},"ReportsReportTablesExportResponse":{"type":"object","properties":{"filename":{"type":"string","minLength":1,"description":"Suggested file name for saving the bytes"},"contentType":{"type":"string","minLength":1},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Short-lived presigned URL that GETs the bytes; null when this deployment cannot sign the object"},"expiresAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}],"description":"When url stops working (minutes after the call); null with url"},"exportId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"This export's id, recorded on its audit row."},"rowCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Rows in the file after its header, the total row included."},"span":{"$ref":"#/components/schemas/ReportsSpan"}},"required":["filename","contentType","byteLength","url","expiresAt","exportId","rowCount","span"],"additionalProperties":false},"ReportsDimensionValuesListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"What a filter on the dimension keeps (its `values`)."},"label":{"type":"string","description":"The value as the product names it."}},"required":["key","label"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"ReportsSavedReportsListResponse":{"type":"object","properties":{"data":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"product":{"type":"string","enum":["discovery","experience","research"],"description":"The product whose results a report reads."},"dataset":{"type":"string","description":"The dataset the report reads (reports.datasets.list.v1)."},"campaignId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The campaign the report reads; null when it reads every campaign of its product."},"status":{"type":"string","enum":["active","archived"]},"createdByUserId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"Who created the report; attribution only."},"createdByName":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The creator's name as the member list shows it; null once the account is gone."},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$","description":"ISO instant, at the store's microsecond precision."},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$","description":"When the report last changed; a replace names it as `expectedUpdatedAt`."}},"required":["id","name","product","dataset","campaignId","status","createdByUserId","createdByName","createdAt","updatedAt"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"ReportsSavedReportsGetResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"product":{"type":"string","enum":["discovery","experience","research"],"description":"The product whose results a report reads."},"dataset":{"type":"string","description":"The dataset the report reads (reports.datasets.list.v1)."},"campaignId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The campaign the report reads; null when it reads every campaign of its product."},"status":{"type":"string","enum":["active","archived"]},"createdByUserId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"Who created the report; attribution only."},"createdByName":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The creator's name as the member list shows it; null once the account is gone."},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$","description":"ISO instant, at the store's microsecond precision."},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$","description":"When the report last changed; a replace names it as `expectedUpdatedAt`."},"definition":{"$ref":"#/components/schemas/ReportsDefinition"}},"required":["id","name","product","dataset","campaignId","status","createdByUserId","createdByName","createdAt","updatedAt","definition"],"additionalProperties":false},"ReportsSavedReportsSaveRequest":{"type":"object","properties":{"id":{"description":"One of the organization's reports to replace, with `expectedUpdatedAt`; omit it to create a report (the server names it).","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"expectedUpdatedAt":{"description":"The `updatedAt` the report was read at; a replace is refused once it moved.","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"name":{"type":"string","minLength":1,"maxLength":120},"definition":{"oneOf":[{"type":"object","properties":{"version":{"type":"number","const":1},"grain":{"type":"string","const":"aggregate"},"dataset":{"type":"string","maxLength":96,"pattern":"^(?:discovery|experience|research)\\.[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"},"scope":{"type":"object","properties":{"campaignId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"profileId":{"default":null,"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"dateRange":{"anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},"required":["campaignId","dateRange"],"additionalProperties":false},"rows":{"maxItems":4,"type":"array","items":{"type":"string","maxLength":64,"pattern":"^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"}},"columns":{"maxItems":2,"type":"array","items":{"type":"string","maxLength":64,"pattern":"^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"}},"values":{"minItems":1,"maxItems":12,"type":"array","items":{"type":"object","properties":{"measure":{"type":"string","maxLength":64,"pattern":"^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"},"showAs":{"type":"string","enum":["value","row","column","total"]}},"required":["measure","showAs"],"additionalProperties":false}},"filters":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"dimension":{"type":"string","maxLength":64,"pattern":"^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"},"values":{"minItems":1,"maxItems":200,"type":"array","items":{"type":"string","minLength":1,"maxLength":256}}},"required":["dimension","values"],"additionalProperties":false}},"sort":{"anyOf":[{"type":"object","properties":{"by":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"dimension"},"key":{"type":"string","maxLength":64,"pattern":"^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"}},"required":["kind","key"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"measure"},"key":{"type":"string","maxLength":64,"pattern":"^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"},"column":{"anyOf":[{"type":"string","maxLength":1024},{"type":"null"}]}},"required":["kind","key","column"],"additionalProperties":false}]},"direction":{"type":"string","enum":["asc","desc"]}},"required":["by","direction"],"additionalProperties":false},{"type":"null"}]},"compare":{"type":"boolean"},"chart":{"anyOf":[{"type":"object","properties":{"mark":{"type":"string","enum":["bar","stacked-bar","stacked-100","line","area","pie"]},"orientation":{"type":"string","enum":["vertical","horizontal"]},"x":{"anyOf":[{"type":"string","maxLength":64,"pattern":"^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"},{"type":"null"}]},"y":{"type":"integer","minimum":0,"maximum":11},"topN":{"type":"integer","minimum":1,"maximum":25},"labels":{"type":"boolean"}},"required":["mark","orientation","x","y","topN","labels"],"additionalProperties":false},{"type":"null"}]}},"required":["version","grain","dataset","scope","rows","columns","values","filters","sort","compare","chart"],"additionalProperties":false},{"type":"object","properties":{"version":{"type":"number","const":1},"grain":{"type":"string","const":"records"},"dataset":{"type":"string","maxLength":96,"pattern":"^(?:discovery|experience|research)\\.[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"},"scope":{"type":"object","properties":{"campaignId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"profileId":{"default":null,"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"dateRange":{"anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},"required":["campaignId","dateRange"],"additionalProperties":false},"fields":{"minItems":1,"maxItems":30,"type":"array","items":{"type":"string","maxLength":64,"pattern":"^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"}},"filters":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"dimension":{"type":"string","maxLength":64,"pattern":"^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"},"values":{"minItems":1,"maxItems":200,"type":"array","items":{"type":"string","minLength":1,"maxLength":256}}},"required":["dimension","values"],"additionalProperties":false}},"sort":{"anyOf":[{"type":"object","properties":{"field":{"type":"string","maxLength":64,"pattern":"^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"},"direction":{"type":"string","enum":["asc","desc"]}},"required":["field","direction"],"additionalProperties":false},{"type":"null"}]}},"required":["version","grain","dataset","scope","fields","filters","sort"],"additionalProperties":false}],"description":"The report definition: the dataset it reads, the campaign and date range (`scope`), and how it groups, shows, filters and sorts; its keys the dataset's (reports.datasets.list.v1)."}},"required":["name","definition"],"additionalProperties":false},"ReportsSavedReportsSaveResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"product":{"type":"string","enum":["discovery","experience","research"],"description":"The product whose results a report reads."},"dataset":{"type":"string","description":"The dataset the report reads (reports.datasets.list.v1)."},"campaignId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The campaign the report reads; null when it reads every campaign of its product."},"status":{"type":"string","enum":["active","archived"]},"createdByUserId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"Who created the report; attribution only."},"createdByName":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The creator's name as the member list shows it; null once the account is gone."},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$","description":"ISO instant, at the store's microsecond precision."},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$","description":"When the report last changed; a replace names it as `expectedUpdatedAt`."},"definition":{"$ref":"#/components/schemas/ReportsDefinition"}},"required":["id","name","product","dataset","campaignId","status","createdByUserId","createdByName","createdAt","updatedAt","definition"],"additionalProperties":false},"ReportsSavedReportsSetStatusRequest":{"type":"object","properties":{"ids":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"status":{"type":"string","enum":["active","archived","deleted"]}},"required":["ids","status"],"additionalProperties":false},"ReportsSavedReportsSetStatusResponse":{"type":"object","properties":{"reports":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"status":{"type":"string","enum":["active","archived","deleted"]}},"required":["id","status"],"additionalProperties":false},"description":"Each report this call changed, with its status."}},"required":["reports"],"additionalProperties":false},"InspectorReading":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"running"},"count":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["kind","count"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"waiting"},"count":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["kind","count"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"next"},"what":{"type":"string","enum":["review","report"]},"at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"timeZone":{"type":"string","minLength":1}},"required":["kind","what","at","timeZone"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"idle"}},"required":["kind"],"additionalProperties":false}]},"DiscoveryLocationContextsItem":{"type":"object","properties":{"addresses":{"minItems":1,"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/DiscoveryAddressesItem"}},"market":{"anyOf":[{"type":"string","maxLength":160},{"type":"null"}]},"country":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"storeIds":{"maxItems":1000,"type":"array","items":{"type":"string","minLength":1,"maxLength":120}},"sourceNotes":{"maxItems":1000,"type":"array","items":{"type":"string","minLength":1,"maxLength":1000}}},"required":["addresses"],"additionalProperties":false},"DiscoveryAddressesItem":{"type":"object","properties":{"googlePlace":{"anyOf":[{"type":"object","properties":{"placeId":{"type":"string","minLength":1,"maxLength":300},"requestToken":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"callId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"requestFingerprint":{"type":"string","pattern":"^[a-f0-9]{64}$"}},"required":["placeId","requestToken","callId","requestFingerprint"],"additionalProperties":false},{"type":"null"}]},"label":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"storeId":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"street":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"city":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"region":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"postalCode":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"country":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180},{"type":"null"}]},"url":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"serviceArea":{"type":"object","properties":{"campaignBoundary":{"type":"object","properties":{"areas":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"query":{"type":"string","minLength":1,"maxLength":160},"countryCode":{"anyOf":[{"type":"string","minLength":2,"maxLength":3},{"type":"null"}]},"weightPct":{"anyOf":[{"type":"number","minimum":0,"maximum":100},{"type":"null"}]}},"required":["query"],"additionalProperties":false}},"evidenceNote":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]}},"required":["areas"],"additionalProperties":false},"configuredRule":{"type":"object","properties":{"strategy":{"type":"string","const":"premises_deepest_reliable"},"version":{"type":"string","const":"physical-service-area:v1"}},"required":["strategy","version"],"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"DiscoveryChanges":{"type":"array","items":{"$ref":"#/components/schemas/DiscoveryItem"},"description":"Each change and when it starts."},"DiscoveryItem":{"type":"object","properties":{"field":{"type":"string","minLength":1,"maxLength":64,"description":"The setting this change moves, in the product's own word (engines, customers…)."},"summary":{"type":"string","minLength":1,"maxLength":500,"description":"The change and when it starts, in plain words."},"starts":{"type":"string","enum":["now","next_run","next_cycle","next_admission_day","when_ready"],"description":"When the change takes effect."},"startsAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}],"description":"The instant it takes effect when known; null when it waits on setup."}},"required":["field","summary","starts","startsAt"],"additionalProperties":false},"DiscoveryEstimate":{"anyOf":[{"type":"object","properties":{"unit":{"type":"object","properties":{"singular":{"type":"string","minLength":1},"plural":{"type":"string","minLength":1}},"required":["singular","plural"],"additionalProperties":false,"description":"What a unit of work is: a conversation, a visit, an interview."},"monthlyBefore":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Estimated units a month today."},"monthlyAfter":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Estimated units a month after the Save."},"unitPriceCents":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}],"description":"Today's price of one unit, in cents; null when Billing could not price it."},"monthlyChangeCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"The change in estimated monthly cost, in cents; null when unpriced."},"oneTime":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["customer_generation","catch_up_run","store_setup","places_search"]},"summary":{"type":"string","minLength":1,"maxLength":500,"description":"The work, in plain words."},"quantity":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"How many units of it."},"amountCents":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}],"description":"Its estimated cost at today's price, in cents; null when it has no estimate."}},"required":["kind","summary","quantity","amountCents"],"additionalProperties":false},"description":"One-time work the Save starts."}},"required":["unit","monthlyBefore","monthlyAfter","unitPriceCents","monthlyChangeCents","oneTime"],"additionalProperties":false},{"type":"null"}],"description":"The change in estimated monthly usage; null when no work changes."},"DiscoveryAddStores":{"description":"Stores to add to a store campaign, as the Google Maps finder picked them; each starts once its customers are ready.","maxItems":309,"type":"array","items":{"$ref":"#/components/schemas/DiscoveryAddressesItem"}},"DiscoveryChanges2":{"type":"array","items":{"$ref":"#/components/schemas/DiscoveryItem"},"description":"What changed and when each starts."},"DiscoveryPrecisionControl":{"anyOf":[{"type":"object","properties":{"control":{"type":"object","properties":{"available":{"type":"boolean"},"reason":{"type":"string","enum":["ok","operator_run","published_pilot","setup_pending","paused","profile_pending","hand_picked","too_many_audiences","not_current_mode","location_campaign","runs_once","viewer_role","not_active"],"description":"Why the control reads as it does; `ok` when the customer may change it."},"title":{"type":"string"},"detail":{"type":"string"},"action":{"description":"The one next step a refusal offers, when the reader has one.","type":"object","properties":{"label":{"type":"string"},"href":{"type":"string"}},"required":["label","href"],"additionalProperties":false}},"required":["available","reason","title","detail"],"additionalProperties":false},"locationCampaign":{"type":"boolean","description":"The campaign targets physical locations."}},"required":["control","locationCampaign"],"additionalProperties":false},{"type":"null"}],"description":"The campaign's precision control as it reads for this caller (a member's role counts; an API key reads the campaign's own verdict), so a surface never offers an order the start would refuse. A campaign that no longer exists, or that the organization's Campaigns list does not hold, is not found."},"DiscoveryOption":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"label":{"type":"string"},"color":{"type":"string"},"dataCount":{"type":"number"},"leadingIcon":{"type":"object","properties":{"src":{"anyOf":[{"type":"string"},{"type":"null"}]},"lightSrc":{"description":"Never sent: a source's favicon is one image for both themes, src.","type":"null"},"darkSrc":{"description":"Never sent: a source's favicon is one image for both themes, src.","type":"null"},"fallbackLabel":{"type":"string"},"fallbackSeed":{"anyOf":[{"type":"string"},{"type":"null"}]},"tone":{"anyOf":[{"type":"string","enum":["dark","light","mixed","unknown"]},{"type":"null"}]},"transparent":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"needsLightBackplate":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"needsDarkBackplate":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"brandColor":{"description":"The brand's assigned color when the row is a campaign brand.","anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["src","fallbackLabel"],"additionalProperties":false},"depth":{"type":"number"}},"required":["id","name","color"],"additionalProperties":false},"DiscoveryWinDriversItem":{"type":"object","properties":{"id":{"type":"string"},"segmentId":{"type":"string"},"kind":{"type":"string","enum":["win","loss"]},"label":{"type":"string"},"count":{"type":"number"},"series":{"description":"Its count in each day's window, the days with a value, labelled by day.","type":"array","items":{"type":"object","properties":{"month":{"type":"string"},"value":{"type":"number"}},"required":["month","value"],"additionalProperties":false}},"precision":{"description":"Never sent: results carry no precision reading. Kept for published callers.","type":"object","properties":{"sampleSize":{"type":"number","description":"Distinct eligible customers behind the value."},"estimatePct":{"type":"number"},"marginOfErrorPct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Delivered margin of error in percent; null: no claim (empty sample)."},"confidenceLevel":{"type":"number"},"generationFocus":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"profile_mix"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"base_bucket"},"dimensionId":{"type":"string","enum":["audience_mix","channel_mix","revenue_mix"]},"bucketId":{"type":"string"},"label":{"type":"string"}},"required":["kind","dimensionId","bucketId","label"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"scaled_profile_mix"},"incidence":{"type":"number"},"label":{"type":"string"}},"required":["kind","incidence","label"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unsupported"}},"required":["kind"],"additionalProperties":false}]},"revenue":{"type":"object","properties":{"influencedUsd":{"type":"number"},"onePointUsd":{"type":"number"}},"required":["influencedUsd","onePointUsd"],"additionalProperties":false}},"required":["sampleSize","marginOfErrorPct","confidenceLevel","generationFocus"],"additionalProperties":false}},"required":["id","segmentId","kind","label","count"],"additionalProperties":false},"DiscoveryWinDrivers":{"type":"array","items":{"$ref":"#/components/schemas/DiscoveryItem2"},"description":"Why the campaign's brand wins against it."},"DiscoveryItem2":{"type":"object","properties":{"id":{"type":"string"},"segmentId":{"type":"string"},"kind":{"type":"string","enum":["win","loss"]},"label":{"type":"string"},"count":{"type":"number","description":"The as-of window's conversations that gave it."},"score":{"description":"The score as it reads, where `count` is not a whole number of conversations.","type":"string"},"series":{"description":"Its count in each day's window, one point per UTC day.","readOnly":true,"type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"UTC day; the value is its trailing 30-day window's."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Null where that window holds no interaction."}},"required":["day","value"],"additionalProperties":false}}},"required":["id","segmentId","kind","label","count"],"additionalProperties":false},"DiscoveryLossDrivers":{"type":"array","items":{"$ref":"#/components/schemas/DiscoveryItem2"},"description":"Why the campaign's brand loses to it."},"DiscoveryLineage":{"type":"object","properties":{"win":{"anyOf":[{"anyOf":[{"type":"object","properties":{"metricId":{"type":"string"},"tables":{"readOnly":true,"type":"array","items":{"type":"string"}},"pipelineStage":{"anyOf":[{"type":"number"},{"type":"null"}]},"campaignId":{"type":"string"},"asOf":{"type":"string","description":"The UTC day the results window ends."},"days":{"type":"number","description":"The window's length in days."}},"required":["metricId","tables","pipelineStage","campaignId","asOf","days"],"additionalProperties":false},{"type":"object","properties":{"metricId":{"type":"string"},"tables":{"readOnly":true,"type":"array","items":{"type":"string"}},"pipelineStage":{"anyOf":[{"type":"number"},{"type":"null"}]},"runId":{"type":"string"}},"required":["metricId","tables","pipelineStage","runId"],"additionalProperties":false}]},{"type":"null"}]},"loss":{"anyOf":[{"anyOf":[{"type":"object","properties":{"metricId":{"type":"string"},"tables":{"readOnly":true,"type":"array","items":{"type":"string"}},"pipelineStage":{"anyOf":[{"type":"number"},{"type":"null"}]},"campaignId":{"type":"string"},"asOf":{"type":"string","description":"The UTC day the results window ends."},"days":{"type":"number","description":"The window's length in days."}},"required":["metricId","tables","pipelineStage","campaignId","asOf","days"],"additionalProperties":false},{"type":"object","properties":{"metricId":{"type":"string"},"tables":{"readOnly":true,"type":"array","items":{"type":"string"}},"pipelineStage":{"anyOf":[{"type":"number"},{"type":"null"}]},"runId":{"type":"string"}},"required":["metricId","tables","pipelineStage","runId"],"additionalProperties":false}]},{"type":"null"}]}},"required":["win","loss"],"additionalProperties":false},"DiscoveryScope":{"type":"object","properties":{"campaignId":{"type":"string"},"state":{"type":"string","enum":["ready","running","failed","out-of-range","no-campaign"],"description":"`ready` carries results; every other state carries none."},"failureReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"perspective":{"anyOf":[{"type":"object","properties":{"brand":{"type":"string","description":"The brand the results were read as."},"isOwnBrand":{"type":"boolean","description":"Whether that brand is the campaign's own."}},"required":["brand","isOwnBrand"],"additionalProperties":false},{"type":"null"}],"description":"The brand lens applied; null when the report honors no lens or carries no results."},"window":{"anyOf":[{"type":"object","properties":{"from":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"The first UTC day a trend plots: the range's, never before the first interaction."},"to":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"The last UTC day a trend plots: the range's end, never past today."},"asOf":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"The UTC day every single value is as of: its value is the average over the campaign's interactions dated in the 30 days ending with it. The range's end, or, when those 30 days hold none, the last day with an interaction."},"comparedTo":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"The day a change compares with: 30 days before asOf."},"interactionCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The interactions dated in the 30 days ending asOf, under the scope."},"customerCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The distinct customers of those interactions."}},"required":["from","to","asOf","comparedTo","interactionCount","customerCount"],"additionalProperties":false},{"type":"null"}],"description":"The results window; null unless `state` is `ready`."}},"required":["campaignId","state","failureReason","perspective","window"],"additionalProperties":false},"DiscoveryKpis":{"type":"object","properties":{"segments":{"readOnly":true,"description":"The segments every read was narrowed to, ANDed; empty is the whole campaign.","type":"array","items":{"type":"object","properties":{"axis":{"type":"string","enum":["audience","channel","market","age","householdIncome","education","lifeStage","areaType","companySize","buyerRole","seniority","occupation","job","triggerType","intentStage","language","gender","product","engine","competitor","topic","sentiment","store","customer"],"description":"A pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or one `store` or `customer`."},"id":{"type":"string","minLength":1,"maxLength":300,"description":"The member's id on that axis, as `discovery.segment-options.get` lists it."}},"required":["axis","id"],"additionalProperties":false}},"targetBrandName":{"anyOf":[{"type":"string"},{"type":"null"}]},"kpis":{"type":"object","properties":{"conversations":{"type":"object","properties":{"value":{"type":"number"},"deltaPts":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The value minus its value 30 days before the window's as-of day; null when either window holds no conversation in scope."}},"required":["value","deltaPts"],"additionalProperties":false},"brandShare":{"$ref":"#/components/schemas/DiscoveryBrandShare"},"brandWinRate":{"$ref":"#/components/schemas/DiscoveryBrandShare"}},"required":["conversations","brandShare","brandWinRate"],"additionalProperties":false,"description":"As of the window's as-of day."},"revenueInfluence":{"type":"object","properties":{"influencedRevenueUsd":{"anyOf":[{"type":"number"},{"type":"null"}]},"influenceableRevenueUsd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Revenue the brand would influence by winning every covered conversation."},"coverage":{"type":"object","properties":{"scope":{"description":"Location estimates may overlap markets.","type":"string","const":"locations"},"status":{"type":"string","enum":["none","partial","complete"]},"includedLineCount":{"type":"number"},"totalLineCount":{"type":"number"},"coveredConversationCount":{"type":"number"},"totalConversationCount":{"type":"number"},"coveragePct":{"type":"number"}},"required":["status","includedLineCount","totalLineCount","coveredConversationCount","totalConversationCount","coveragePct"],"additionalProperties":false},"lines":{"type":"array","items":{"type":"object","properties":{"revenueLineId":{"type":"string"},"locationKey":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Null at company scope."},"name":{"type":"string"},"annualSalesUsd":{"type":"number"},"aiInfluencePct":{"type":"number"},"serviceableAvailableMarketUsd":{"type":"number","description":"SAM: annual sales ÷ market share."},"aiInfluencedSalesUsd":{"type":"number","description":"Annual sales × AI influence: the brand's own sales, which the line's dollars may exceed."},"aiInfluencedMarketUsd":{"type":"number","description":"SAM × AI influence, a year: the line's dollars are a share of it, and a point is a hundredth of it."},"wins":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The brand's wins of conversations."},"conversations":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"Every conversation on the line in the as-of window, in or out of the segments."},"point":{"type":"object","properties":{"pointValueUsd":{"type":"number","description":"One point of the line's win rate, in dollars."},"basis":{"type":"string","enum":["ceiling"],"description":"Always ceiling: a point is aiInfluencedMarketUsd ÷ 100, whatever the rate."}},"required":["pointValueUsd","basis"],"additionalProperties":false},"influencedRevenueUsd":{"type":"number","description":"The segments' dollars on the line."},"influenceableRevenueUsd":{"type":"number","description":"The segments' dollars on the line had the brand won every conversation."}},"required":["revenueLineId","locationKey","name","annualSalesUsd","aiInfluencePct","serviceableAvailableMarketUsd","aiInfluencedSalesUsd","aiInfluencedMarketUsd","wins","conversations","point","influencedRevenueUsd","influenceableRevenueUsd"],"additionalProperties":false},"description":"The covered products (revenue lines), at company scope or one location, that influencedRevenueUsd adds up: each line's dollars are aiInfluencedMarketUsd × the segments' won conversations ÷ conversations, so over the whole window point × win rate."}},"required":["influencedRevenueUsd","influenceableRevenueUsd","coverage","lines"],"additionalProperties":false,"description":"Over the as-of window: the share of each line's AI-influenced market the brand's wins capture, a year, so it can exceed aiInfluencedSalesUsd; a point of a line's win rate is worth aiInfluencedMarketUsd ÷ 100. Zero coverage when the lens is not the campaign's own brand."},"benchmarks":{"type":"object","properties":{"brandShare":{"anyOf":[{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"number"}},"required":["name","value"],"additionalProperties":false},{"type":"null"}]},"brandWinRate":{"anyOf":[{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"number"}},"required":["name","value"],"additionalProperties":false},{"type":"null"}]}},"required":["brandShare","brandWinRate"],"additionalProperties":false,"description":"The highest other brand by each metric, as of the as-of day."},"customerCount":{"type":"number","description":"Distinct customers of the as-of window's conversations: the sample brand share and win rate stand on."},"earlierCustomerCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct customers of the conversations in the window 30 days before the as-of day, which every change compares with."},"kpiSeries":{"type":"object","properties":{"conversations":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"UTC day; the value is its trailing 30-day window's."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Null where that window holds no interaction."}},"required":["day","value"],"additionalProperties":false},"description":"One point per UTC day of the window's span, each that day's trailing 30-day window's value."},"brandShare":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"UTC day; the value is its trailing 30-day window's."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Null where that window holds no interaction."}},"required":["day","value"],"additionalProperties":false},"description":"One point per UTC day of the window's span, each that day's trailing 30-day window's value."},"brandWinRate":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"UTC day; the value is its trailing 30-day window's."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Null where that window holds no interaction."}},"required":["day","value"],"additionalProperties":false},"description":"One point per UTC day of the window's span, each that day's trailing 30-day window's value."}},"required":["conversations","brandShare","brandWinRate"],"additionalProperties":false},"breaks":{"description":"Days in the trends' span the campaign's conversations changed behavior version (its opening questions, customer replies or interview schedule), each with what changed; absent with none.","type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"label":{"type":"string"}},"required":["day","label"],"additionalProperties":false}}},"required":["segments","targetBrandName","kpis","revenueInfluence","benchmarks","customerCount","earlierCustomerCount","kpiSeries"],"additionalProperties":false},"DiscoveryBrandShare":{"type":"object","properties":{"value":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"measured"},"value":{"type":"number"}},"required":["kind","value"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"absent"},"reason":{"type":"string","enum":["no_measurement_in_scope","no_conversations_in_segment"],"description":"`no_conversations_in_segment`: the segments left no conversation of the window; `no_measurement_in_scope`: the window, unnarrowed, holds none the figure counts."}},"required":["kind","reason"],"additionalProperties":false}],"description":"The figure (`kind` measured, `value` in percent), or `kind` absent with the `reason` nothing in scope measured it: never a 0 for an empty denominator."},"deltaPts":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The value minus its value 30 days before the window's as-of day; null when either window holds no conversation in scope."}},"required":["value","deltaPts"],"additionalProperties":false},"DiscoveryOptionClasses":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["unowned_offering","approach"]},"name":{"type":"string"},"brandShare":{"type":"number","description":"Share of conversations that put forward an option of the class."},"brandWinRate":{"type":"number","description":"Share of conversations whose final pick was an option of the class."},"options":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"mentions":{"type":"number"},"wins":{"type":"number"},"sites":{"type":"array","items":{"type":"string"},"description":"Hosts of the pages cited for it."}},"required":["name","mentions","wins","sites"],"additionalProperties":false},"description":"The class's options, most mentioned first."},"optionTotalCount":{"type":"number"}},"required":["kind","name","brandShare","brandWinRate","options","optionTotalCount"],"additionalProperties":false},"description":"Offerings put forward with no named provider, and approaches: classes, not brands, so no benchmark or head-to-head reads them."},"DiscoveryWhyWeWin":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"score":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Conversations of the as-of window that gave it."},"customers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct customers of the as-of window's conversations its kind counts from (the brand's wins for a win reason, its losses for a loss reason)."},"direction":{"type":"string","enum":["up","down","flat"]},"series":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"UTC day; the value is its trailing 30-day window's."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Null where that window holds no interaction."}},"required":["day","value"],"additionalProperties":false},"description":"Its count in each day's window; empty for a competitor comparison."}},"required":["label","score","customers","direction","series"],"additionalProperties":false}},"DiscoveryBrandScopes":{"anyOf":[{"type":"object","properties":{"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"relationshipType":{"type":"string","enum":["target","competitor","partner","hybrid","influencer","adjacent","unrelated","unknown"]},"isTarget":{"type":"boolean"}},"required":["id","name","relationshipType","isTarget"],"additionalProperties":false}},"segments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"color":{"type":"string"},"markerColor":{"type":"string"},"barColor":{"type":"string"},"relationshipType":{"anyOf":[{"type":"string","enum":["target","competitor","partner","hybrid","influencer","adjacent","unrelated","unknown"]},{"type":"string","enum":["replacement_competitor","decision_influencer"]}]},"topCompetitor":{"anyOf":[{"type":"string"},{"type":"null"}]},"topBrands":{"type":"array","items":{"type":"string"}},"bestTopic":{"anyOf":[{"type":"string"},{"type":"null"}]},"isLeader":{"type":"boolean"},"parentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"childIds":{"type":"array","items":{"type":"string"}},"geoRegion":{"anyOf":[{"type":"string"},{"type":"null"}]},"geoResolution":{"anyOf":[{"type":"string","enum":["countries","provinces","postal"]},{"type":"null"}]}},"required":["id","name","color"],"additionalProperties":false}},"includeZeroSegments":{"type":"boolean"},"metricsByBrandId":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"object","properties":{"portfolioWinRate":{"type":"number"},"cells":{"type":"array","items":{"readOnly":true,"type":"array","prefixItems":[{"type":"number"},{"type":"number"},{"type":"number"},{"type":"number"}]},"description":"[segmentIndex, brandShare, winRate, eligibleCustomerCount]"}},"required":["portfolioWinRate","cells"],"additionalProperties":false}}},"required":["options","segments","includeZeroSegments","metricsByBrandId"],"additionalProperties":false},{"type":"null"}]},"DiscoveryLineSeries":{"type":"object","properties":{"shareTrend":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"UTC day; the value is its trailing 30-day window's."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Null where that window holds no interaction."}},"required":["day","value"],"additionalProperties":false},"description":"Brand share (%) in each day's window; null where it holds none of the segment's conversations."},"winTrend":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"UTC day; the value is its trailing 30-day window's."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Null where that window holds no interaction."}},"required":["day","value"],"additionalProperties":false},"description":"Brand win rate (%) in each day's window; null where it holds none of the segment's conversations."}},"required":["shareTrend","winTrend"],"additionalProperties":false},"DiscoveryDrivers":{"type":"array","items":{"type":"object","properties":{"audienceId":{"type":"string"},"kind":{"type":"string","enum":["win","loss"]},"label":{"type":"string","description":"The reason, as the model wrote it."},"count":{"type":"number","description":"Conversations of the as-of window citing the reason."},"customers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct customers of the as-of window's conversations its kind counts from (wins for a win reason, losses for a loss reason): the sample its count stands on."},"series":{"description":"Its count in each day's window; null where the window holds none of its segment's conversations.","type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"UTC day; the value is its trailing 30-day window's."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Null where that window holds no interaction."}},"required":["day","value"],"additionalProperties":false}}},"required":["audienceId","kind","label","count","customers"],"additionalProperties":false}},"DiscoveryAudienceSeries":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/DiscoveryLineSeries"},"description":"Keyed by audience id."},"DiscoveryScope2":{"type":"object","properties":{"campaignId":{"type":"string"},"state":{"type":"string","enum":["ready","running","failed","out-of-range","no-campaign"],"description":"`ready` carries results; every other state carries none."},"dispatchId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The newest run that measured a conversation of the results window's as-of window."},"failureReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"perspective":{"anyOf":[{"type":"object","properties":{"brand":{"type":"string","description":"The brand the results were read as."},"isOwnBrand":{"type":"boolean","description":"Whether that brand is the campaign's own."}},"required":["brand","isOwnBrand"],"additionalProperties":false},{"type":"null"}],"description":"The brand lens applied; null when the report honors no lens or carries no results."}},"required":["campaignId","state","dispatchId","failureReason","perspective"],"additionalProperties":false},"DiscoveryReportDrivers":{"type":"array","items":{"type":"object","properties":{"competitorId":{"type":"string"},"kind":{"type":"string","enum":["win","loss"]},"label":{"type":"string","description":"The reason, as the model wrote it."},"count":{"type":"number","description":"Conversations of the as-of window citing the reason."},"customers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct customers of the as-of window's conversations its kind counts from (wins for a win reason, losses for a loss reason): the sample its count stands on."},"series":{"description":"Its count in each day's window; null where the window holds none of its segment's conversations.","type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"UTC day; the value is its trailing 30-day window's."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Null where that window holds no interaction."}},"required":["day","value"],"additionalProperties":false}}},"required":["competitorId","kind","label","count","customers"],"additionalProperties":false}},"DiscoveryCompetitorSeries":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"object","properties":{"shareTrend":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"UTC day; the value is its trailing 30-day window's."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Null where that window holds no interaction."}},"required":["day","value"],"additionalProperties":false},"description":"Brand share (%) in each day's window; null where it holds none of the segment's conversations."},"winTrend":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"UTC day; the value is its trailing 30-day window's."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Null where that window holds no interaction."}},"required":["day","value"],"additionalProperties":false},"description":"Brand win rate (%) in each day's window; null where it holds none of the segment's conversations."}},"required":["shareTrend","winTrend"],"additionalProperties":false,"description":"The brand's share and win rate in each day's window: 0 where that window's conversations never named it, null where it holds no conversation in scope."},"description":"Keyed by competitor id."},"DiscoveryReportDrivers2":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["win","loss"]},"label":{"type":"string","description":"The reason, as the model wrote it."},"count":{"type":"number","description":"The source's net influence (or win impact), rounded."},"series":{"description":"Its count in each day's window; null where the window holds none of its segment's conversations.","type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"UTC day; the value is its trailing 30-day window's."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Null where that window holds no interaction."}},"required":["day","value"],"additionalProperties":false}}},"required":["kind","label","count"],"additionalProperties":false}},"DiscoverySourceSeries":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"object","properties":{"shareTrend":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"UTC day; the value is its trailing 30-day window's."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Null where that window holds no interaction."}},"required":["day","value"],"additionalProperties":false},"description":"Its share (%) of the listed sources' citations in each day's window; null where it holds no conversation in scope."},"winTrend":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"UTC day; the value is its trailing 30-day window's."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Null where that window holds no interaction."}},"required":["day","value"],"additionalProperties":false},"description":"Its citations in each day's window; null where it holds no conversation in scope."}},"required":["shareTrend","winTrend"],"additionalProperties":false},"description":"Keyed by source id: each source the as-of window lists."},"DiscoveryLadder":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"rank":{"type":"number","description":"1-based circle position by graded head-to-head strength."},"isTarget":{"type":"boolean","description":"True for the campaign's own brand."},"kind":{"description":"How the rival competes; null for the campaign's own brand or when unclassified.","anyOf":[{"type":"string","enum":["competitor","hybrid"]},{"type":"null"}]},"relationshipTypeCounts":{"description":"Every label beside the rival's kind, with how often it was given.","type":"object","propertyNames":{"type":"string","enum":["competitor","partner","hybrid","influencer","adjacent","unrelated","unknown"]},"additionalProperties":{"type":"number"}},"pairWins":{"type":"number"},"pairLosses":{"type":"number"},"dominance":{"type":"number"}},"required":["key","name","rank","isTarget"],"additionalProperties":false},"description":"The brand picker's universe: evidence-gated brands in strength order, then below-gate brands with a decided matchup."},"DiscoverySources":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"domain":{"type":"string"},"label":{"type":"string"},"typeId":{"type":"string","description":"The source type node the domain flows into."},"share":{"type":"number","description":"Share (0..1) of total influence weight."},"conversationCount":{"type":"number"},"isOwned":{"type":"boolean","description":"True when the domain is the campaign brand's own."},"icon":{"anyOf":[{"$ref":"#/components/schemas/DiscoveryIcon"},{"type":"null"}]}},"required":["id","domain","label","typeId","share","conversationCount","isOwned","icon"],"additionalProperties":false},"description":"Top domains across every type, ranked by influence share."},"DiscoveryIcon":{"type":"object","properties":{"faviconUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"faviconLightUrl":{"default":null,"description":"Always null: a source's favicon is one image for both themes, faviconUrl.","type":"null"},"faviconDarkUrl":{"default":null,"description":"Always null: a source's favicon is one image for both themes, faviconUrl.","type":"null"},"faviconFallbackLabel":{"anyOf":[{"type":"string"},{"type":"null"}]},"faviconTone":{"type":"string","enum":["dark","light","mixed","unknown"]},"faviconTransparent":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"faviconNeedsLightBackplate":{"type":"boolean"},"faviconNeedsDarkBackplate":{"type":"boolean"},"brandColor":{"description":"The campaign's assigned color token for this brand.","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["faviconUrl","faviconLightUrl","faviconDarkUrl","faviconFallbackLabel","faviconTone","faviconTransparent","faviconNeedsLightBackplate","faviconNeedsDarkBackplate"],"additionalProperties":false},"DiscoveryMap":{"anyOf":[{"type":"object","properties":{"datasetKey":{"type":"string"},"targetBrandName":{"anyOf":[{"type":"string"},{"type":"null"}]},"artifact":{"anyOf":[{"type":"object","properties":{"version":{"type":"number","const":1},"market_summary":{"type":"string","minLength":1},"strata":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"label":{"type":"string","minLength":1},"order":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["id","label","order"],"additionalProperties":false}},"roles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"label":{"type":"string","minLength":1},"stratum":{"type":"string","minLength":1},"tier":{"type":"string","enum":["core","detail"]},"inferred":{"type":"boolean"},"description":{"type":"string","minLength":1}},"required":["id","label","stratum","tier","inferred","description"],"additionalProperties":false}},"label_map":{"type":"array","items":{"type":"object","properties":{"canonical_label":{"type":"string","minLength":1},"role_id":{"type":"string","minLength":1}},"required":["canonical_label","role_id"],"additionalProperties":false}},"edges":{"type":"array","items":{"type":"object","properties":{"source_role_id":{"type":"string","minLength":1},"predicate":{"type":"string","enum":["sells_to","contracts_with","distributes_through","supplies","regulates","competes_with"]},"target_role_id":{"type":"string","minLength":1}},"required":["source_role_id","predicate","target_role_id"],"additionalProperties":false}},"customer_anchor_role_id":{"type":"string","minLength":1}},"required":["version","market_summary","strata","roles","label_map","edges","customer_anchor_role_id"],"additionalProperties":false},{"type":"null"}],"description":"The market ontology as written; null when the campaign has none."},"absence":{"anyOf":[{"type":"string","enum":["in_progress","next_daily_run","none"]},{"type":"null"}],"description":"Why there is no map; null when `artifact` is set. `in_progress`: the first run writes it; `next_daily_run`: the next daily run writes it; `none`: nothing will."},"brandClusters":{"type":"array","items":{"type":"object","properties":{"roleId":{"type":"string"},"brands":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"isTargetBrand":{"type":"boolean"},"source":{"type":"string","enum":["observed","profile"]},"mentions":{"description":"The as-of window's conversations where an answer brought the brand up.","type":"number"}},"required":["name","isTargetBrand","source"],"additionalProperties":false}}},"required":["roleId","brands"],"additionalProperties":false}},"brandNames":{"type":"array","items":{"type":"string"},"description":"The brand names whose favicons `discovery.brand-icons.get.v2` reads for this map."}},"required":["datasetKey","targetBrandName","artifact","absence","brandClusters","brandNames"],"additionalProperties":false},{"type":"null"}],"description":"Null unless `scope.state` is `ready`."},"DiscoveryData":{"maxItems":12,"type":"array","items":{"type":"object","properties":{"customerId":{"type":"string"},"customerName":{"type":"string"},"customerSubtitle":{"type":"string","description":"The customer's job title, else their age; empty when neither is known."},"conversation":{"type":"object","properties":{"id":{"type":"string"},"campaignId":{"type":"string"},"campaignName":{"type":"string"},"engine":{"type":"string","description":"The assistant's name, e.g. ChatGPT."},"engineId":{"type":"string","description":"The assistant's provider id, e.g. openai."},"occurredAt":{"type":"string","description":"ISO timestamp the conversation started."},"scoring":{"anyOf":[{"type":"object","properties":{"brands":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"color":{"anyOf":[{"type":"string"},{"type":"null"}]},"role":{"type":"string","enum":["target","competitor","other"]}},"required":["id","name","color","role"],"additionalProperties":false}}},"required":["brands"],"additionalProperties":false},{"type":"null"}],"description":"The brands the conversation named, in order; null when it named none."},"turns":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string","enum":["user","assistant"],"description":"`user` is the customer; `assistant` the AI."},"body":{"type":"string"},"at":{"description":"ISO timestamp, when the transcript kept one.","anyOf":[{"type":"string"},{"type":"null"}]},"label":{"description":"The speaker: the customer's name or the assistant's.","type":"string"},"sources":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"siteName":{"anyOf":[{"type":"string"},{"type":"null"}]},"faviconUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"faviconLightUrl":{"description":"Never sent: a source's favicon is one image for both themes, faviconUrl.","type":"null"},"faviconDarkUrl":{"description":"Never sent: a source's favicon is one image for both themes, faviconUrl.","type":"null"},"faviconTone":{"anyOf":[{"type":"string","enum":["dark","light","mixed","unknown"]},{"type":"null"}]},"faviconTransparent":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"faviconNeedsLightBackplate":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"faviconNeedsDarkBackplate":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["url"],"additionalProperties":false}},"searchQueries":{"type":"array","items":{"type":"string"}}},"required":["id","role","body"],"additionalProperties":false},"description":"The conversation's first turns."}},"required":["id","campaignId","campaignName","engine","engineId","occurredAt","scoring","turns"],"additionalProperties":false}},"required":["customerId","customerName","customerSubtitle","conversation"],"additionalProperties":false}},"DiscoveryData2":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"conversationId":{"type":"string","description":"The Discovery conversation's id."},"customerId":{"type":"string","description":"The customer's id, which business.customer-conversations.get takes."},"customerKey":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The customer's key in the customer pages."},"customerName":{"type":"string"},"customerSubtitle":{"type":"string","description":"The customer's job title, else their age; empty when neither is known."},"engine":{"type":"string","description":"The assistant's name, e.g. ChatGPT."},"engineId":{"type":"string","description":"The assistant's provider id, e.g. openai."},"occurredAt":{"type":"string","description":"ISO timestamp the conversation started."},"turnCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Turns the transcript shows."},"outcome":{"type":"string","enum":["won","mentioned","absent"],"description":"The campaign brand's outcome: `won`; `mentioned`, named while another brand or none won; `absent`, not named."},"winnerBrand":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The brand the conversation recommended, if any."},"mentionedBrands":{"maxItems":12,"type":"array","items":{"type":"string"},"description":"The brands the conversation named, in the order the analysis recorded them, at most 12."},"mentionedBrandCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"How many brands the conversation named in all."},"firstPrompt":{"type":"string","description":"The customer's first prompt on one line, shortened."},"match":{"anyOf":[{"type":"object","properties":{"field":{"type":"string","enum":["customer","prompt","answer"],"description":"Where the first hit is: the customer's name, a prompt, or an answer."},"turnIndex":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}],"description":"The hit's turn, counted from 0 in the turns business.customer-conversations.get returns; null for a hit in the customer's name."},"excerpt":{"type":"string","description":"The text around the hit, on one line."},"start":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Where the hit starts in `excerpt`, in UTF-16 code units."},"end":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Where the hit ends in `excerpt`, in UTF-16 code units."}},"required":["field","turnIndex","excerpt","start","end"],"additionalProperties":false},{"type":"null"}],"description":"Where a search hit; null without a search."},"sourceCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Sources the answers cited."}},"required":["conversationId","customerId","customerKey","customerName","customerSubtitle","engine","engineId","occurredAt","turnCount","outcome","winnerBrand","mentionedBrands","mentionedBrandCount","firstPrompt","match","sourceCount"],"additionalProperties":false}},"DiscoveryCustomers":{"type":"object","properties":{"points":{"type":"array","items":{"type":"object","properties":{"totalConversations":{"type":"number"},"mentioned":{"type":"number"},"won":{"type":"number"},"positive":{"type":"number","description":"Conversations whose target-brand record carried a positive tone."},"negative":{"type":"number","description":"Conversations whose target-brand record carried a negative tone."},"customerId":{"type":"string"},"latitude":{"type":"number"},"longitude":{"type":"number"},"locationKey":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The store the customer was generated for; null for an unbound one."},"choices":{"type":"array","items":{"type":"object","properties":{"brand":{"type":"string"},"count":{"type":"number"},"isTarget":{"type":"boolean"}},"required":["brand","count","isTarget"],"additionalProperties":false},"description":"Every recorded choice, including repeated conversations."},"lastEndedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the customer's latest conversation of the read ended (ISO); null for a customer not heard in it."}},"required":["totalConversations","mentioned","won","positive","negative","customerId","latitude","longitude","locationKey","choices","lastEndedAt"],"additionalProperties":false}},"unmapped":{"type":"number","description":"Roster members with no usable home point."},"total":{"type":"number","description":"Roster members the read holds, mapped or not."},"truncated":{"type":"boolean","description":"True when the campaign holds more mapped customers than the map returns."},"siteOutcomes":{"type":"array","items":{"type":"object","properties":{"totalConversations":{"type":"number"},"mentioned":{"type":"number"},"won":{"type":"number"},"positive":{"type":"number","description":"Conversations whose target-brand record carried a positive tone."},"negative":{"type":"number","description":"Conversations whose target-brand record carried a negative tone."},"locationKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"choices":{"type":"array","items":{"type":"object","properties":{"brand":{"type":"string"},"count":{"type":"number"},"isTarget":{"type":"boolean"}},"required":["brand","count","isTarget"],"additionalProperties":false},"description":"Every recorded choice, including repeated conversations."}},"required":["totalConversations","mentioned","won","positive","negative","locationKey","choices"],"additionalProperties":false},"description":"Every outcome of the read by assigned store, unmapped customers included."}},"required":["points","unmapped","total","truncated","siteOutcomes"],"additionalProperties":false},"DiscoveryCustomer":{"type":"object","properties":{"totalConversations":{"type":"number"},"mentioned":{"type":"number"},"won":{"type":"number"},"positive":{"type":"number","description":"Conversations whose target-brand record carried a positive tone."},"negative":{"type":"number","description":"Conversations whose target-brand record carried a negative tone."},"choices":{"type":"array","items":{"type":"object","properties":{"brand":{"type":"string"},"count":{"type":"number"},"isTarget":{"type":"boolean"}},"required":["brand","count","isTarget"],"additionalProperties":false},"description":"Every recorded choice, including repeated conversations."},"latestChoice":{"anyOf":[{"type":"object","properties":{"brand":{"type":"string"},"isTarget":{"type":"boolean"}},"required":["brand","isTarget"],"additionalProperties":false},{"type":"null"}],"description":"Who the customer's latest conversation of the read with a recorded choice chose; null when none recorded one."},"customerId":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"age":{"anyOf":[{"type":"number"},{"type":"null"}]},"jobTitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"employer":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"region":{"anyOf":[{"type":"string"},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"locationKey":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["totalConversations","mentioned","won","positive","negative","choices","latestChoice","customerId","name","age","jobTitle","employer","city","region","latitude","longitude","locationKey"],"additionalProperties":false},"DiscoveryForm":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}]},"mode":{"type":"string","const":"current"},"businessProfileId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"targetedGroupIds":{"anyOf":[{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"type":"null"}]},"targetedCustomerIds":{"anyOf":[{"minItems":1,"maxItems":1000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"type":"null"}]},"manualAudiences":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":200},"count":{"type":"integer","minimum":1,"maximum":5000},"overrideManifest":{"oneOf":[{"$ref":"#/components/schemas/DiscoveryOverrideManifest"},{"$ref":"#/components/schemas/DiscoveryItemOverrideManifest"},{"type":"object","properties":{"version":{"type":"number","const":1},"baseGenerationProfileId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"baseSourceHash":{"type":"string","pattern":"^[a-f0-9]{64}$"},"profileName":{"type":"string","minLength":1,"maxLength":160},"overrides":{"type":"object","propertyNames":{"type":"string","enum":["job_mix","trigger_type_mix","audience_mix","channel_mix","revenue_mix","intent_stage_mix","age_mix","gender_mix","education_mix","household_income_mix","urbanicity_mix","regional_mix","life_stage_mix","language_mix","occupation_mix","company_size_mix","buyer_role_mix","seniority_mix","job_title_mix","years_in_role_mix"]},"additionalProperties":{"minItems":1,"maxItems":100,"type":"array","items":{"oneOf":[{"type":"object","properties":{"source":{"type":"string","const":"base"},"bucketId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"label":{"type":"string","minLength":1,"maxLength":160},"weightPct":{"type":"number","exclusiveMinimum":0,"maximum":100}},"required":["source","bucketId","label","weightPct"],"additionalProperties":false},{"type":"object","properties":{"source":{"type":"string","const":"new"},"clientKey":{"type":"string","minLength":1,"maxLength":128},"label":{"type":"string","minLength":1,"maxLength":160},"weightPct":{"type":"number","exclusiveMinimum":0,"maximum":100},"basedOnBucketId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"}},"required":["source","clientKey","label","weightPct"],"additionalProperties":false}]}}}},"required":["version","baseGenerationProfileId","baseSourceHash","profileName","overrides"],"additionalProperties":false}]}},"required":["id","count","overrideManifest"],"additionalProperties":false}},"locationContexts":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/DiscoveryLocationContextsItem"}},"locationCoverageMode":{"default":"standard","type":"string","enum":["standard","one_per_location"]},"engines":{"minItems":1,"maxItems":4,"type":"array","items":{"type":"string","enum":["chatgpt","gemini","claude","grok"]}},"marginOfError":{"type":"number","enum":[10,5,1]},"targetCustomerCount":{"description":"How many customers the campaign runs, in total across its locations; each has one conversation a month with every engine. Omit it for the sample marginOfError requires at 95% confidence, or 97 per location. At least 100 without locations, or one per location. A campaign of chosen customers (targetedCustomerIds) runs exactly those, so a count, if sent, is how many were chosen.","type":"integer","minimum":1,"maximum":30000}},"required":["name","url","mode","businessProfileId","targetedGroupIds","targetedCustomerIds","engines","marginOfError"],"additionalProperties":false,"description":"The campaign: name, website url (nullable when businessProfileId is supplied), mode (always current), business profile, saved audiences or explicit customers (the campaign runs exactly those; a targetCustomerCount, if sent, must equal their number), manual audiences, locations and their coverage, AI engines, margin of error, and optional customer target."},"DiscoveryOverrideManifest":{"type":"object","properties":{"version":{"type":"number","const":3},"baseGenerationProfileId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"baseSourceHash":{"type":"string","pattern":"^[a-f0-9]{64}$"},"profileName":{"type":"string","minLength":1,"maxLength":160},"overrides":{"$ref":"#/components/schemas/DiscoveryOverrides"},"employerAccounts":{"minItems":1,"maxItems":1000,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":160},"domain":{"anyOf":[{"type":"string","maxLength":253,"pattern":"^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?[.])+([a-z]{2,63}|xn--[a-z0-9-]{1,59})$"},{"type":"null"}]}},"required":["name","domain"],"additionalProperties":false}},"givenFacts":{"$ref":"#/components/schemas/DiscoveryGivenFacts"}},"required":["version","baseGenerationProfileId","baseSourceHash","profileName","overrides"],"additionalProperties":false},"DiscoveryOverrides":{"type":"object","propertyNames":{"type":"string","enum":["job_mix","trigger_type_mix","audience_mix","channel_mix","revenue_mix","intent_stage_mix","age_mix","gender_mix","education_mix","household_income_mix","urbanicity_mix","regional_mix","life_stage_mix","language_mix","occupation_mix","company_size_mix","buyer_role_mix","seniority_mix","job_title_mix","years_in_role_mix"]},"additionalProperties":{"minItems":1,"maxItems":100,"type":"array","items":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"ref"},"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"label":{"type":"string","minLength":1,"maxLength":160},"weightPct":{"type":"number","exclusiveMinimum":0,"maximum":100},"purchaseMode":{"type":"string","enum":["on_premises","local_service_area","remote_direct","third_party","sales_led"]}},"required":["kind","id","label","weightPct"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"authored"},"clientKey":{"type":"string","minLength":1,"maxLength":128},"label":{"type":"string","minLength":1,"maxLength":160},"weightPct":{"type":"number","exclusiveMinimum":0,"maximum":100},"templateId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"purchaseMode":{"type":"string","enum":["on_premises","local_service_area","remote_direct","third_party","sales_led"]}},"required":["kind","clientKey","label","weightPct"],"additionalProperties":false}]}}},"DiscoveryGivenFacts":{"type":"object","properties":{"age":{"type":"object","properties":{"value":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"band":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["value","band"],"additionalProperties":false},"location":{"type":"object","properties":{"countryCode":{"type":"string","pattern":"^[A-Z]{2}$"},"subdivisionCode":{"anyOf":[{"type":"string","pattern":"^[A-Z]{2}-[A-Z0-9]{1,3}$"},{"type":"null"}]},"locality":{"anyOf":[{"type":"string","minLength":1,"maxLength":160},{"type":"null"}]},"postalCode":{"anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},"required":["countryCode","subdivisionCode"],"additionalProperties":false},"household":{"anyOf":[{"type":"object","properties":{"adults":{"anyOf":[{"type":"integer","minimum":0,"maximum":99},{"type":"null"}]},"children":{"anyOf":[{"type":"integer","minimum":0,"maximum":99},{"type":"null"}]},"pets":{"anyOf":[{"type":"integer","minimum":0,"maximum":99},{"type":"null"}]}},"required":["adults","children","pets"],"additionalProperties":false},{"type":"object","properties":{"statement":{"type":"string","minLength":1,"maxLength":1000}},"required":["statement"],"additionalProperties":false}]},"householdIncome":{"type":"object","properties":{"value":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"band":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["value","band"],"additionalProperties":false},"jobTitle":{"type":"string","minLength":1,"maxLength":160},"employer":{"type":"string","minLength":1,"maxLength":160},"yearsInRole":{"type":"object","properties":{"value":{"type":"number","minimum":0}},"required":["value"],"additionalProperties":false},"companySize":{"type":"object","properties":{"value":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"band":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["value","band"],"additionalProperties":false},"annualRevenue":{"type":"object","properties":{"value":{"type":"number","minimum":0}},"required":["value"],"additionalProperties":false},"stakeholders":{"type":"string","minLength":1,"maxLength":1000},"budget":{"type":"string","minLength":1,"maxLength":1000},"constraints":{"type":"string","minLength":1,"maxLength":1000},"situation":{"type":"string","minLength":1,"maxLength":1000},"trigger":{"type":"string","minLength":1,"maxLength":1000},"functionalNeed":{"type":"string","minLength":1,"maxLength":1000},"emotionalNeed":{"type":"string","minLength":1,"maxLength":1000},"socialNeed":{"type":"string","minLength":1,"maxLength":1000},"desiredOutcome":{"type":"string","minLength":1,"maxLength":1000},"labels":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"string","minLength":1,"maxLength":120}}},"additionalProperties":false},"DiscoveryItemOverrideManifest":{"type":"object","properties":{"version":{"type":"number","const":2},"baseGenerationProfileId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"baseSourceHash":{"type":"string","pattern":"^[a-f0-9]{64}$"},"profileName":{"type":"string","minLength":1,"maxLength":160},"overrides":{"$ref":"#/components/schemas/DiscoveryOverrides"},"employerAccounts":{"minItems":1,"maxItems":1000,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":160},"domain":{"anyOf":[{"type":"string","maxLength":253,"pattern":"^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?[.])+([a-z]{2,63}|xn--[a-z0-9-]{1,59})$"},{"type":"null"}]}},"required":["name","domain"],"additionalProperties":false}}},"required":["version","baseGenerationProfileId","baseSourceHash","profileName","overrides"],"additionalProperties":false},"DiscoveryData3":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customerKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"type":"string"},"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"businessProfileKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"profileName":{"anyOf":[{"type":"string"},{"type":"null"}]},"profileUrl":{"type":"string"},"profileBusinessSummary":{"anyOf":[{"type":"string"},{"type":"null"}]},"source":{"type":"string","enum":["generated","manual","connected"]},"poolStatus":{"type":"string","enum":["active","retired"]},"retiredAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"forecastSeeded":{"type":"boolean"},"audiences":{"type":"array","items":{"type":"string"}},"systemAudiences":{"type":"array","items":{"type":"string"}},"userAudiences":{"type":"array","items":{"type":"string"}},"userAudienceIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"sources":{"type":"array","items":{"type":"string"}},"jobTitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"gender":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Gender"},"age":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Age"},"age.band":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Age band"},"language":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Language"},"location":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Location"},"market":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Market"},"areaType":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Area type"},"education":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Education"},"lifeStage":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Life stage"},"householdIncome":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Household income"},"householdIncome.band":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Income band"},"occupation":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Occupation"},"seniority":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Seniority"},"employer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Employer"},"companySize":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Company size"},"companySize.band":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Size band"},"annualRevenue":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Annual revenue"},"buyerType":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Buyer type"},"audience":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Audience"},"product":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Product"},"channel":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Channel"},"buyerRole":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Buyer role"},"intentStage":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Intent stage"},"job":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Job to be done"},"triggerType":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Trigger type"},"trigger":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Trigger"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"generationRunId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"latestDiscoveryOutcome":{"$ref":"#/components/schemas/DiscoveryLatestDiscoveryOutcome"},"audienceMemberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"createdBy":{"type":"string","enum":["system","user"]}},"required":["id","name","createdBy"],"additionalProperties":false}},"place":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","customerKey","label","businessProfileId","businessProfileKey","profileName","profileUrl","profileBusinessSummary","source","poolStatus","retiredAt","forecastSeeded","audiences","systemAudiences","userAudiences","userAudienceIds","sources","jobTitle","gender","age","age.band","language","location","market","areaType","education","lifeStage","householdIncome","householdIncome.band","occupation","seniority","employer","companySize","companySize.band","annualRevenue","buyerType","audience","product","channel","buyerRole","intentStage","job","triggerType","trigger","createdAt","generationRunId","latestDiscoveryOutcome","audienceMemberships","place"],"additionalProperties":false}},"DiscoveryLatestDiscoveryOutcome":{"anyOf":[{"type":"object","properties":{"result":{"type":"string","enum":["won","lost"]},"brand":{"type":"string"},"color":{"anyOf":[{"type":"string"},{"type":"null"}]},"source":{"anyOf":[{"type":"object","properties":{"url":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"type":"string"},"faviconUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"faviconLightUrl":{"description":"Never sent: a source's favicon is one image for both themes, faviconUrl.","type":"null"},"faviconDarkUrl":{"description":"Never sent: a source's favicon is one image for both themes, faviconUrl.","type":"null"},"faviconTone":{"anyOf":[{"type":"string","enum":["dark","light","mixed","unknown"]},{"type":"null"}]},"faviconTransparent":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"faviconNeedsLightBackplate":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"faviconNeedsDarkBackplate":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"color":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["url","label","faviconUrl"],"additionalProperties":false},{"type":"null"}]}},"required":["result","brand"],"additionalProperties":false},{"type":"null"}]},"DiscoveryData4":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customerKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"type":"string"},"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"businessProfileKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"profileName":{"anyOf":[{"type":"string"},{"type":"null"}]},"profileUrl":{"type":"string"},"profileBusinessSummary":{"anyOf":[{"type":"string"},{"type":"null"}]},"source":{"type":"string","enum":["generated","manual","connected"]},"poolStatus":{"type":"string","enum":["active","retired"]},"retiredAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"forecastSeeded":{"type":"boolean"},"audiences":{"type":"array","items":{"type":"string"}},"systemAudiences":{"type":"array","items":{"type":"string"}},"userAudiences":{"type":"array","items":{"type":"string"}},"userAudienceIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"sources":{"type":"array","items":{"type":"string"}},"jobTitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"gender":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Gender"},"age":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Age"},"age.band":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Age band"},"language":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Language"},"location":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Location"},"market":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Market"},"areaType":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Area type"},"education":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Education"},"lifeStage":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Life stage"},"householdIncome":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Household income"},"householdIncome.band":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Income band"},"occupation":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Occupation"},"seniority":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Seniority"},"employer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Employer"},"companySize":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Company size"},"companySize.band":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Size band"},"annualRevenue":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Annual revenue"},"buyerType":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Buyer type"},"audience":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Audience"},"product":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Product"},"channel":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Channel"},"buyerRole":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Buyer role"},"intentStage":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Intent stage"},"job":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Job to be done"},"triggerType":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Trigger type"},"trigger":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Trigger"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"generationRunId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"latestDiscoveryOutcome":{"$ref":"#/components/schemas/DiscoveryItemLatestDiscoveryOutcome"},"audienceMemberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"createdBy":{"type":"string","enum":["system","user"]}},"required":["id","name","createdBy"],"additionalProperties":false}},"place":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","customerKey","label","businessProfileId","businessProfileKey","profileName","profileUrl","profileBusinessSummary","source","poolStatus","retiredAt","forecastSeeded","audiences","systemAudiences","userAudiences","userAudienceIds","sources","jobTitle","gender","age","age.band","language","location","market","areaType","education","lifeStage","householdIncome","householdIncome.band","occupation","seniority","employer","companySize","companySize.band","annualRevenue","buyerType","audience","product","channel","buyerRole","intentStage","job","triggerType","trigger","createdAt","generationRunId","latestDiscoveryOutcome","audienceMemberships","place"],"additionalProperties":false}},"DiscoveryItemLatestDiscoveryOutcome":{"anyOf":[{"type":"object","properties":{"result":{"type":"string","enum":["won","lost"]},"brand":{"type":"string"},"color":{"anyOf":[{"type":"string"},{"type":"null"}]},"source":{"anyOf":[{"type":"object","properties":{"url":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"type":"string"},"faviconUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"faviconTone":{"anyOf":[{"type":"string","enum":["dark","light","mixed","unknown"]},{"type":"null"}]},"faviconTransparent":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"faviconNeedsLightBackplate":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"faviconNeedsDarkBackplate":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"color":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["url","label","faviconUrl"],"additionalProperties":false},{"type":"null"}]}},"required":["result","brand"],"additionalProperties":false},{"type":"null"}]},"DiscoveryFilters":{"type":"object","properties":{"date_range":{"type":"string","description":"Required. Use \"all\" or one absolute UTC-day range in yyyy-MM-dd..yyyy-MM-dd form. Preset names are not accepted because a saved answer must not move over time."},"brand_perspective":{"description":"Optional exact brand name for the dashboard's read-only perspective. Omit for the campaign's target brand.","type":"string","minLength":1,"maxLength":240},"geography":{"description":"Optional exact navigable dashboard-scope id or unambiguous visible label of a place with places under it, for example \"Texas\". Omit for World, the dashboard default scope.","type":"string","minLength":1,"maxLength":240},"geography_view":{"description":"Optional. \"list\" for the ranked table, or \"map\" for the countries filled on a world map, which is drawn only at World (no geography). Omit for the map where it can be drawn, else the list.","type":"string","enum":["map","list"]}},"required":["date_range"],"additionalProperties":false,"description":"The filters the view was read with: brand_perspective only when the lens is not the campaign's own brand; for Locations, geography (the id of the scope it shows, absent at World) and geography_view (the form it draws)."},"DiscoveryProvenance":{"type":"object","properties":{"campaign":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},"filters":{"$ref":"#/components/schemas/DiscoveryFilters"},"filterLabels":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"The filter's name, as its view declares it."},"label":{"type":"string","description":"The filter's short label, as every host shows it."},"value":{"type":"string","description":"The value it was read with, as the dashboard shows it."}},"required":["key","label","value"],"additionalProperties":false},"description":"The filters as a host labels them, in the view's declared order."},"window":{"type":"object","properties":{"from":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"to":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"asOf":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"}},"required":["from","to","asOf"],"additionalProperties":false,"description":"The results window the image's values read, as of asOf."},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"The version of the view's snapshot."},"snapshotDigest":{"type":"string","pattern":"^[0-9a-f]{64}$","description":"The view's snapshotDigest: what the image's card drew."},"format":{"type":"string","enum":["slide","square","card"]},"theme":{"type":"string","enum":["light","dark"]},"scale":{"type":"number","enum":[1,2]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"retainedUntil":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}],"description":"When the image stops being kept."},"canonicalHref":{"type":"string","pattern":"^\\/app\\/.*","description":"The dashboard page that shows the view, under the same filters."}},"required":["campaign","filters","filterLabels","window","version","snapshotDigest","format","theme","scale","createdAt","retainedUntil","canonicalHref"],"additionalProperties":false},"AlphaSelection":{"type":"object","properties":{"modelId":{"type":"string","pattern":"^[a-z0-9-]+\\/.+$"},"reasoning":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"provider-default"}},"required":["type"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"enabled"}},"required":["type"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"disabled"}},"required":["type"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"effort"},"effort":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,31}$"}},"required":["type","effort"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"budget-tokens"},"budgetTokens":{"type":"integer","minimum":0,"maximum":2147483647}},"required":["type","budgetTokens"],"additionalProperties":false}]},"fallback":{"anyOf":[{"type":"object","properties":{"modelId":{"type":"string","pattern":"^[a-z0-9-]+\\/.+$"},"reasoning":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"provider-default"}},"required":["type"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"enabled"}},"required":["type"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"disabled"}},"required":["type"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"effort"},"effort":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,31}$"}},"required":["type","effort"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"budget-tokens"},"budgetTokens":{"type":"integer","minimum":0,"maximum":2147483647}},"required":["type","budgetTokens"],"additionalProperties":false}]}},"required":["modelId","reasoning"],"additionalProperties":false},{"type":"null"}]}},"required":["modelId","reasoning"],"additionalProperties":false},"AlphaOutputsItem":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":100},"assetId":{"type":"string","enum":["image-ad","video-ad","landing-page","search-ad","carousel-ad","collection-ad","email","social-post","product-image","display-banner","demo","presentation","document","case-study","website-section","message","lead-form","thumbnail","audio","brand-graphic","print","music","interactive"]},"label":{"type":"string","minLength":1,"maxLength":100},"format":{"type":"string","minLength":1,"maxLength":100},"platforms":{"minItems":1,"type":"array","items":{"type":"string","enum":["Facebook","Instagram","Google Search","YouTube","LinkedIn","TikTok","Gmail","Discover","Google Display","Microsoft / Bing","Pinterest","Reddit","Amazon","Snapchat","Spotify and podcasts","X","Website","Email and messaging","Sales and brand","Print and events"]}},"placement":{"type":"string","minLength":1},"ratio":{"type":"string"},"size":{"type":"string"},"note":{"type":"string"},"sources":{"minItems":1,"type":"array","items":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"evidence":{"type":"string","minLength":1}},"required":["url","evidence"],"additionalProperties":false}},"restrictions":{"type":"array","items":{"type":"string"}},"medium":{"type":"string","enum":["text","image","video","audio","document","presentation","page"]},"unit":{"type":"string","enum":["feed","story","in-stream","shorts","search","sitelinks","display-banner","responsive-display","carousel","collection","pin","gmail","discover","audio-spot","podcast","in-feed-video","text-ad","document-ad","thumbnail"]},"exports":{"$ref":"#/components/schemas/AlphaExports"},"slots":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","enum":["primaryText","headline","longHeadline","description","businessName","callToAction","displayUrl","path1","path2","sitelinkText","sitelinkDescription","cardHeadline","cardDescription","hashtags","subject","preheader","body","script","caption","altText"]},"maxChars":{"type":"integer","exclusiveMinimum":0,"maximum":10000},"minCount":{"type":"integer","minimum":0,"maximum":30},"maxCount":{"type":"integer","exclusiveMinimum":0,"maximum":30}},"required":["slot","minCount","maxCount"],"additionalProperties":false}}},"required":["id","assetId","label","format","platforms","placement","sources","restrictions"],"additionalProperties":false},"AlphaExports":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":60},"role":{"type":"string","enum":["main","card","cover","tile","logo","companion","thumbnail"]},"medium":{"type":"string","enum":["text","image","video","audio","document","presentation","page"]},"width":{"type":"integer","exclusiveMinimum":0,"maximum":10000},"height":{"type":"integer","exclusiveMinimum":0,"maximum":10000},"ratio":{"type":"string","minLength":1,"maxLength":20},"minWidth":{"type":"integer","exclusiveMinimum":0,"maximum":10000},"minHeight":{"type":"integer","exclusiveMinimum":0,"maximum":10000},"pixelDensity":{"type":"integer","minimum":1,"maximum":3},"formats":{"minItems":1,"maxItems":14,"type":"array","items":{"type":"string","enum":["png","jpeg","webp","gif","mp4","mov","webm","mp3","wav","ogg","aac","pdf","docx","pptx"]}},"maxBytes":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"minSeconds":{"type":"number","exclusiveMinimum":0,"maximum":36000},"maxSeconds":{"type":"number","exclusiveMinimum":0,"maximum":36000},"recommendedSeconds":{"type":"number","exclusiveMinimum":0,"maximum":36000},"minCount":{"type":"integer","exclusiveMinimum":0,"maximum":100},"maxCount":{"type":"integer","exclusiveMinimum":0,"maximum":100},"loudnessLufs":{"type":"number","minimum":-40,"maximum":0},"safeTop":{"type":"number","minimum":0,"maximum":0.5},"safeBottom":{"type":"number","minimum":0,"maximum":0.5},"safeSides":{"type":"number","minimum":0,"maximum":0.5}},"required":["id","role","medium"],"additionalProperties":false}},"AlphaTarget":{"anyOf":[{"$ref":"#/components/schemas/AlphaTargetVariant"},{"type":"null"}]},"AlphaTargetVariant":{"anyOf":[{"type":"object","properties":{"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"region":{"type":"object","properties":{"x":{"type":"number","minimum":0,"maximum":1},"y":{"type":"number","minimum":0,"maximum":1},"width":{"type":"number","exclusiveMinimum":0,"maximum":1},"height":{"type":"number","exclusiveMinimum":0,"maximum":1}},"required":["x","y","width","height"],"additionalProperties":false}},"required":["artifactId"],"additionalProperties":false},{"type":"object","properties":{"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"edits":{"type":"object","properties":{"trimStartSeconds":{"type":"number","minimum":0},"trimEndSeconds":{"type":"number","exclusiveMinimum":0},"playbackRate":{"type":"number","minimum":0.25,"maximum":4},"volume":{"type":"number","minimum":0,"maximum":4},"fadeInSeconds":{"type":"number","minimum":0},"fadeOutSeconds":{"type":"number","minimum":0},"crop":{"type":"object","properties":{"x":{"type":"number","minimum":0,"maximum":1},"y":{"type":"number","minimum":0,"maximum":1},"width":{"type":"number","exclusiveMinimum":0,"maximum":1},"height":{"type":"number","exclusiveMinimum":0,"maximum":1}},"required":["x","y","width","height"],"additionalProperties":false},"rotate":{"anyOf":[{"type":"number","const":0},{"type":"number","const":90},{"type":"number","const":180},{"type":"number","const":270}]},"flipHorizontal":{"type":"boolean"},"flipVertical":{"type":"boolean"},"brightness":{"type":"number","minimum":0,"maximum":2},"contrast":{"type":"number","minimum":0,"maximum":2},"saturation":{"type":"number","minimum":0,"maximum":2},"resize":{"type":"object","properties":{"width":{"type":"integer","minimum":16,"maximum":8192},"height":{"type":"integer","minimum":16,"maximum":8192},"fit":{"type":"string","enum":["cover","contain"]},"background":{"type":"string","enum":["black","white","transparent"]}},"required":["width","height","fit"],"additionalProperties":false},"format":{"type":"string","enum":["png","jpeg","webp","mp4","mp3","wav"]},"maxBytes":{"type":"integer","minimum":1024,"maximum":209715200},"loudnessLufs":{"type":"number","minimum":-40,"maximum":-5}},"additionalProperties":false}},"required":["artifactId","edits"],"additionalProperties":false}]},"AlphaModels":{"type":"object","properties":{"research.ask_data":{"$ref":"#/components/schemas/AlphaSelection"},"research.ask_data_creation":{"$ref":"#/components/schemas/AlphaSelection"},"research.alpha_create_image":{"$ref":"#/components/schemas/AlphaSelection"},"research.alpha_edit_image":{"$ref":"#/components/schemas/AlphaSelection"}},"additionalProperties":false},"AlphaDeliverablesItem":{"type":"object","properties":{"assetId":{"type":"string","minLength":1,"maxLength":100},"format":{"type":"string","minLength":1,"maxLength":200},"platforms":{"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":100}},"artifactIds":{"maxItems":10,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"fileRoles":{"maxItems":10,"type":"array","items":{"type":"string","enum":["main","card","cover","tile","logo","companion","thumbnail"]}},"primaryText":{"type":"string","minLength":1,"maxLength":3000},"headline":{"type":"string","minLength":1,"maxLength":300},"longHeadline":{"type":"string","minLength":1,"maxLength":300},"description":{"type":"string","minLength":1,"maxLength":1000},"businessName":{"type":"string","minLength":1,"maxLength":100},"callToAction":{"type":"string","minLength":1,"maxLength":60},"displayUrl":{"type":"string","minLength":1,"maxLength":200},"destinationUrl":{"type":"string","minLength":1,"maxLength":2000},"path1":{"type":"string","minLength":1,"maxLength":60},"path2":{"type":"string","minLength":1,"maxLength":60},"headlines":{"maxItems":15,"type":"array","items":{"type":"string","minLength":1,"maxLength":300}},"descriptions":{"maxItems":5,"type":"array","items":{"type":"string","minLength":1,"maxLength":1000}},"sitelinkTexts":{"maxItems":8,"type":"array","items":{"type":"string","minLength":1,"maxLength":100}},"sitelinkDescriptions":{"maxItems":16,"type":"array","items":{"type":"string","minLength":1,"maxLength":200}},"cardHeadlines":{"maxItems":10,"type":"array","items":{"type":"string","minLength":1,"maxLength":300}},"cardDescriptions":{"maxItems":10,"type":"array","items":{"type":"string","minLength":1,"maxLength":1000}},"hashtags":{"maxItems":30,"type":"array","items":{"type":"string","minLength":1,"maxLength":100}},"subjects":{"maxItems":10,"type":"array","items":{"type":"string","minLength":1,"maxLength":300}},"preheader":{"type":"string","minLength":1,"maxLength":300},"body":{"type":"string","minLength":1,"maxLength":20000},"messages":{"maxItems":10,"type":"array","items":{"type":"string","minLength":1,"maxLength":1000}},"script":{"type":"string","minLength":1,"maxLength":10000},"caption":{"type":"string","minLength":1,"maxLength":3000},"altText":{"type":"string","minLength":1,"maxLength":500}},"required":["assetId","format","platforms","artifactIds"],"additionalProperties":false},"AlphaBrief":{"type":"object","properties":{"mode":{"type":"string","enum":["channels","assets"]},"direction":{"type":"string","maxLength":4000},"channels":{"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":100}},"assets":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":100},"label":{"type":"string","minLength":1,"maxLength":100},"platforms":{"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":100}},"formats":{"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":100}},"specifications":{"maxItems":40,"type":"array","items":{"type":"object","properties":{"revisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"output":{"$ref":"#/components/schemas/AlphaOutputsItem"}},"required":["revisionId","output"],"additionalProperties":false}},"medium":{"type":"string","enum":["text","image","video","audio","document","presentation","page"]},"exports":{"$ref":"#/components/schemas/AlphaExports"},"slots":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","enum":["primaryText","headline","longHeadline","description","businessName","callToAction","displayUrl","path1","path2","sitelinkText","sitelinkDescription","cardHeadline","cardDescription","hashtags","subject","preheader","body","script","caption","altText"]},"maxChars":{"type":"integer","exclusiveMinimum":0,"maximum":10000},"minCount":{"type":"integer","minimum":0,"maximum":30},"maxCount":{"type":"integer","exclusiveMinimum":0,"maximum":30}},"required":["slot","minCount","maxCount"],"additionalProperties":false}}},"required":["id","label","platforms","formats","specifications"],"additionalProperties":false}},"attachmentIds":{"maxItems":5,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"models":{"$ref":"#/components/schemas/AlphaModels"}},"required":["direction","channels","assets","attachmentIds"],"additionalProperties":false},"AlphaRound":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"projectId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ordinal":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"mode":{"type":"string","enum":["variants","edit","exact"]},"baseArtifactId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"instruction":{"type":"string","maxLength":4000},"target":{"$ref":"#/components/schemas/AlphaTarget"},"turnId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"pricingPolicy":{"anyOf":[{"type":"string","const":"studio-api-v1"},{"type":"null"}]},"models":{"$ref":"#/components/schemas/AlphaModels"},"refusal":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","minLength":1,"maxLength":100},"message":{"type":"string","minLength":1,"maxLength":1000}},"required":["code","message"],"additionalProperties":false},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["id","projectId","ordinal","mode","baseArtifactId","instruction","target","turnId","pricingPolicy","refusal","createdAt"],"additionalProperties":false},"AlphaGraph":{"type":"object","properties":{"schemaVersion":{"type":"number","const":1},"nodeCatalogVersion":{"type":"number","const":1},"nodes":{"$ref":"#/components/schemas/AlphaNodes"},"edges":{"minItems":2,"maxItems":60,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"},"source":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"},"target":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"}},"required":["id","source","target"],"additionalProperties":false}}},"required":["schemaVersion","nodeCatalogVersion","nodes","edges"],"additionalProperties":false},"AlphaNodes":{"minItems":3,"maxItems":30,"type":"array","items":{"$ref":"#/components/schemas/AlphaItem"}},"AlphaItem":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"},"position":{"type":"object","properties":{"x":{"type":"number","minimum":-20000,"maximum":20000},"y":{"type":"number","minimum":-20000,"maximum":20000}},"required":["x","y"],"additionalProperties":false},"type":{"type":"string","const":"manual_trigger"},"data":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":120}},"required":["label"],"additionalProperties":false}},"required":["id","position","type","data"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"},"position":{"type":"object","properties":{"x":{"type":"number","minimum":-20000,"maximum":20000},"y":{"type":"number","minimum":-20000,"maximum":20000}},"required":["x","y"],"additionalProperties":false},"type":{"type":"string","const":"ai_generate"},"data":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":120},"instructions":{"type":"string","minLength":8,"maxLength":8000},"outputLabel":{"type":"string","minLength":1,"maxLength":120}},"required":["label","instructions","outputLabel"],"additionalProperties":false}},"required":["id","position","type","data"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"},"position":{"type":"object","properties":{"x":{"type":"number","minimum":-20000,"maximum":20000},"y":{"type":"number","minimum":-20000,"maximum":20000}},"required":["x","y"],"additionalProperties":false},"type":{"type":"string","const":"deliverable"},"data":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":120},"description":{"type":"string","minLength":1,"maxLength":1000}},"required":["label","description"],"additionalProperties":false}},"required":["id","position","type","data"],"additionalProperties":false}]},"AlphaGraph2":{"type":"object","properties":{"schemaVersion":{"type":"number","const":2},"nodeCatalogVersion":{"type":"number","const":1},"nodes":{"$ref":"#/components/schemas/AlphaNodes"},"edges":{"minItems":2,"maxItems":60,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"},"source":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"},"target":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"}},"required":["id","source","target"],"additionalProperties":false}},"internalReport":{"type":"object","properties":{"kind":{"type":"string","const":"internal_report"},"campaign":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":120}},"required":["id","name"],"additionalProperties":false},"actions":{"minItems":1,"maxItems":5,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"title":{"type":"string","minLength":1,"maxLength":120}},"required":["id","title"],"additionalProperties":false}}},"required":["kind","campaign","actions"],"additionalProperties":false}},"required":["schemaVersion","nodeCatalogVersion","nodes","edges","internalReport"],"additionalProperties":false},"AlphaGraph3":{"type":"object","properties":{"schemaVersion":{"type":"number","const":3},"nodeCatalogVersion":{"type":"number","const":2},"nodes":{"minItems":3,"maxItems":3,"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/AlphaItem"},{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"},"position":{"type":"object","properties":{"x":{"type":"number","minimum":-20000,"maximum":20000},"y":{"type":"number","minimum":-20000,"maximum":20000}},"required":["x","y"],"additionalProperties":false},"type":{"type":"string","const":"ai_generate"},"data":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":120},"instructions":{"type":"string","minLength":8,"maxLength":8000},"outputLabel":{"type":"string","minLength":1,"maxLength":120},"tools":{"maxItems":1,"type":"array","items":{"type":"string","const":"point11_data"}}},"required":["label","instructions","outputLabel","tools"],"additionalProperties":false}},"required":["id","position","type","data"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"},"position":{"type":"object","properties":{"x":{"type":"number","minimum":-20000,"maximum":20000},"y":{"type":"number","minimum":-20000,"maximum":20000}},"required":["x","y"],"additionalProperties":false},"type":{"type":"string","const":"solution_design"},"data":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":120}},"required":["label"],"additionalProperties":false}},"required":["id","position","type","data"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"},"position":{"type":"object","properties":{"x":{"type":"number","minimum":-20000,"maximum":20000},"y":{"type":"number","minimum":-20000,"maximum":20000}},"required":["x","y"],"additionalProperties":false},"type":{"type":"string","const":"artifact_render"},"data":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":120}},"required":["label"],"additionalProperties":false}},"required":["id","position","type","data"],"additionalProperties":false}]}},"edges":{"minItems":2,"maxItems":2,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"},"source":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"},"target":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"}},"required":["id","source","target"],"additionalProperties":false}},"solutionDesign":{"type":"object","properties":{"sourceReport":{"type":"object","properties":{"runId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"workflowVersionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"deliverableNodeId":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"},"sha256":{"type":"string","pattern":"^[0-9a-f]{64}$"}},"required":["runId","workflowVersionId","deliverableNodeId","sha256"],"additionalProperties":false},"audience":{"type":"string","minLength":8,"maxLength":1000},"goal":{"type":"string","minLength":8,"maxLength":1000},"templateId":{"type":"string","const":"landing-page-v1"}},"required":["sourceReport","audience","goal","templateId"],"additionalProperties":false}},"required":["schemaVersion","nodeCatalogVersion","nodes","edges","solutionDesign"],"additionalProperties":false},"AlphaGraph4":{"type":"object","properties":{"schemaVersion":{"type":"number","const":4},"nodeCatalogVersion":{"type":"number","const":3},"nodes":{"minItems":3,"maxItems":30,"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"},"position":{"type":"object","properties":{"x":{"type":"number","minimum":-20000,"maximum":20000},"y":{"type":"number","minimum":-20000,"maximum":20000}},"required":["x","y"],"additionalProperties":false},"type":{"type":"string","const":"manual_trigger"},"data":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":120}},"required":["label"],"additionalProperties":false}},"required":["id","position","type","data"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"},"position":{"type":"object","properties":{"x":{"type":"number","minimum":-20000,"maximum":20000},"y":{"type":"number","minimum":-20000,"maximum":20000}},"required":["x","y"],"additionalProperties":false},"type":{"type":"string","const":"ai_generate"},"data":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":120},"instructions":{"type":"string","minLength":8,"maxLength":8000},"outputLabel":{"type":"string","minLength":1,"maxLength":120},"tools":{"maxItems":1,"type":"array","items":{"type":"string","const":"point11_data"}}},"required":["label","instructions","outputLabel","tools"],"additionalProperties":false}},"required":["id","position","type","data"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"},"position":{"type":"object","properties":{"x":{"type":"number","minimum":-20000,"maximum":20000},"y":{"type":"number","minimum":-20000,"maximum":20000}},"required":["x","y"],"additionalProperties":false},"type":{"type":"string","const":"deliverable"},"data":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":120},"description":{"type":"string","minLength":1,"maxLength":1000}},"required":["label","description"],"additionalProperties":false}},"required":["id","position","type","data"],"additionalProperties":false}]}},"edges":{"minItems":2,"maxItems":60,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"},"source":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"},"target":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"}},"required":["id","source","target"],"additionalProperties":false}}},"required":["schemaVersion","nodeCatalogVersion","nodes","edges"],"additionalProperties":false},"AlphaRecentRuns":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"status":{"type":"string","enum":["pending","running","succeeded","failed","cancelled"]},"executionStatus":{"type":"string","enum":["scheduled","waiting","running","completed","failed","cancelled"]},"artifacts":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"status":{"type":"string","const":"draft"}},"required":["label","artifactId","status"],"additionalProperties":false}},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"completedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]}},"required":["id","status","executionStatus","artifacts","createdAt","completedAt"],"additionalProperties":false}},"AlphaGraph5":{"oneOf":[{"$ref":"#/components/schemas/AlphaGraph"},{"$ref":"#/components/schemas/AlphaGraph2"},{"$ref":"#/components/schemas/AlphaGraph3"},{"$ref":"#/components/schemas/AlphaGraph4"},{"type":"object","properties":{"schemaVersion":{"type":"number","const":5},"nodeCatalogVersion":{"type":"number","const":4},"nodes":{"minItems":3,"maxItems":30,"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"},"position":{"type":"object","properties":{"x":{"type":"number","minimum":-20000,"maximum":20000},"y":{"type":"number","minimum":-20000,"maximum":20000}},"required":["x","y"],"additionalProperties":false},"type":{"type":"string","const":"manual_trigger"},"data":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":120}},"required":["label"],"additionalProperties":false}},"required":["id","position","type","data"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"},"position":{"type":"object","properties":{"x":{"type":"number","minimum":-20000,"maximum":20000},"y":{"type":"number","minimum":-20000,"maximum":20000}},"required":["x","y"],"additionalProperties":false},"type":{"type":"string","const":"ai_generate"},"data":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":120},"instructions":{"type":"string","minLength":8,"maxLength":8000},"outputLabel":{"type":"string","minLength":1,"maxLength":120},"tools":{"maxItems":1,"type":"array","items":{"type":"string","const":"point11_data"}}},"required":["label","instructions","outputLabel","tools"],"additionalProperties":false}},"required":["id","position","type","data"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"},"position":{"type":"object","properties":{"x":{"type":"number","minimum":-20000,"maximum":20000},"y":{"type":"number","minimum":-20000,"maximum":20000}},"required":["x","y"],"additionalProperties":false},"type":{"type":"string","const":"deliverable"},"data":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":120},"description":{"type":"string","minLength":1,"maxLength":1000}},"required":["label","description"],"additionalProperties":false}},"required":["id","position","type","data"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"},"position":{"type":"object","properties":{"x":{"type":"number","minimum":-20000,"maximum":20000},"y":{"type":"number","minimum":-20000,"maximum":20000}},"required":["x","y"],"additionalProperties":false},"type":{"type":"string","const":"create_file"},"data":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":120},"format":{"type":"string","enum":["pptx","xlsx","docx","pdf"]},"brandKitArtifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"title":{"type":"string","minLength":1,"maxLength":160},"instructions":{"type":"string","minLength":8,"maxLength":8000}},"required":["label","format","brandKitArtifactId","title","instructions"],"additionalProperties":false}},"required":["id","position","type","data"],"additionalProperties":false}]}},"edges":{"minItems":2,"maxItems":60,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"},"source":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"},"target":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"}},"required":["id","source","target"],"additionalProperties":false}}},"required":["schemaVersion","nodeCatalogVersion","nodes","edges"],"additionalProperties":false}]},"AlphaKit":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"kitKey":{"type":"string"},"name":{"type":"string"},"sourceUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","enum":["active","retired"]},"version":{"type":"integer","minimum":0,"maximum":9007199254740991},"currentRevisionArtifactId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["id","kitKey","name","sourceUrl","status","version","currentRevisionArtifactId","createdAt","updatedAt"],"additionalProperties":false},"AlphaRevision":{"anyOf":[{"type":"object","properties":{"kitId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"kitKey":{"type":"string"},"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revision":{"type":"integer","minimum":0,"maximum":9007199254740991},"parentArtifactId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"document":{"anyOf":[{"$ref":"#/components/schemas/AlphaDocument"},{"type":"object","properties":{"version":{"type":"string","const":"2"},"name":{"type":"string","minLength":1,"maxLength":120},"colors":{"type":"object","properties":{"primary":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"secondary":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"accent":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"background":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"text":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"palette":{"maxItems":8,"type":"array","items":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"}}},"required":["primary"],"additionalProperties":false},"typography":{"type":"object","properties":{"heading":{"type":"string","minLength":1,"maxLength":80},"body":{"type":"string","minLength":1,"maxLength":80}},"required":["heading","body"],"additionalProperties":false},"logoArtifactIds":{"default":[],"maxItems":4,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"voiceId":{"type":"string","minLength":1,"maxLength":100},"doNotRules":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":200}},"writing":{"default":{"tone":[],"terminology":[],"examples":[]},"type":"object","properties":{"tone":{"default":[],"maxItems":12,"type":"array","items":{"type":"string","minLength":1,"maxLength":120}},"audience":{"type":"string","minLength":1,"maxLength":1000},"terminology":{"default":[],"maxItems":30,"type":"array","items":{"type":"string","minLength":1,"maxLength":200}},"examples":{"default":[],"maxItems":8,"type":"array","items":{"type":"string","minLength":1,"maxLength":1000}}},"required":["tone","terminology","examples"],"additionalProperties":false},"layout":{"default":{"spacing":[]},"type":"object","properties":{"description":{"type":"string","minLength":1,"maxLength":4000},"spacing":{"default":[],"maxItems":16,"type":"array","items":{"type":"string","minLength":1,"maxLength":120}},"corners":{"type":"string","minLength":1,"maxLength":120},"buttons":{"type":"string","minLength":1,"maxLength":1000},"imagery":{"type":"string","minLength":1,"maxLength":1000},"responsive":{"type":"string","minLength":1,"maxLength":1000},"documentTemplate":{"type":"string","minLength":1,"maxLength":4000},"presentationTemplate":{"type":"string","minLength":1,"maxLength":4000},"spreadsheetTemplate":{"type":"string","minLength":1,"maxLength":4000},"adTemplate":{"type":"string","minLength":1,"maxLength":4000},"websiteTemplate":{"type":"string","minLength":1,"maxLength":4000}},"required":["spacing"],"additionalProperties":false},"evidence":{"default":{"sources":[],"gaps":[]},"type":"object","properties":{"sourceUrl":{"type":"string","maxLength":2048,"format":"uri"},"finalUrl":{"type":"string","maxLength":2048,"format":"uri"},"observedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"sources":{"default":[],"maxItems":30,"type":"array","items":{"type":"object","properties":{"url":{"type":"string","maxLength":2048,"format":"uri"},"observation":{"type":"string","minLength":1,"maxLength":2000}},"required":["url","observation"],"additionalProperties":false}},"gaps":{"default":[],"maxItems":30,"type":"array","items":{"type":"string","minLength":1,"maxLength":500}}},"required":["sources","gaps"],"additionalProperties":false},"assetUsage":{"$ref":"#/components/schemas/AlphaAssetUsage"},"overrides":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["name","colors","typography","logoArtifactIds","voiceId","doNotRules","writing","layout","assetUsage"]},"action":{"type":"string","enum":["set","remove"]},"source":{"type":"string","enum":["customer","import"]}},"required":["field","action","source"],"additionalProperties":false}}},"required":["version","name","colors","typography","logoArtifactIds","doNotRules","writing","layout","evidence","assetUsage","overrides"],"additionalProperties":false}]},"origin":{"type":"string","enum":["extraction","manual","chat"]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["kitId","kitKey","artifactId","revision","parentArtifactId","document","origin","createdAt"],"additionalProperties":false},{"type":"null"}]},"AlphaDocument":{"type":"object","properties":{"version":{"type":"string","const":"1"},"name":{"type":"string","minLength":1,"maxLength":120},"colors":{"type":"object","properties":{"primary":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"secondary":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"accent":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"background":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"text":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"palette":{"maxItems":8,"type":"array","items":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"}}},"required":["primary"],"additionalProperties":false},"typography":{"type":"object","properties":{"heading":{"type":"string","minLength":1,"maxLength":80},"body":{"type":"string","minLength":1,"maxLength":80}},"required":["heading","body"],"additionalProperties":false},"logoArtifactIds":{"default":[],"maxItems":4,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"voiceId":{"type":"string","minLength":1,"maxLength":100},"doNotRules":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":200}}},"required":["version","name","colors","typography","logoArtifactIds","doNotRules"],"additionalProperties":false},"AlphaAssetUsage":{"default":[],"maxItems":64,"type":"array","items":{"type":"object","properties":{"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"role":{"type":"string","enum":["logo","logo_dark","icon","image","font_heading","font_body","screenshot","template","reference"]},"mediaType":{"type":"string","enum":["application/vnd.openxmlformats-officedocument.wordprocessingml.document","application/vnd.openxmlformats-officedocument.presentationml.presentation","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","application/pdf","image/png","image/jpeg","image/webp","image/svg+xml","font/woff","font/woff2","font/ttf","font/otf"]},"label":{"type":"string","minLength":1,"maxLength":160},"sourceUrl":{"type":"string","maxLength":2048,"format":"uri"},"usage":{"type":"string","enum":["reference_only","web","embed","unavailable"]},"restriction":{"type":"string","minLength":1,"maxLength":500},"licence":{"type":"object","properties":{"basis":{"type":"string","const":"customer_asserted"},"assertedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["basis"],"additionalProperties":false}},"required":["artifactId","role","label","usage"],"additionalProperties":false}},"AlphaRevision2":{"anyOf":[{"type":"object","properties":{"kitId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"kitKey":{"type":"string"},"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revision":{"type":"integer","minimum":0,"maximum":9007199254740991},"parentArtifactId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"document":{"anyOf":[{"$ref":"#/components/schemas/AlphaDocument"},{"type":"object","properties":{"version":{"type":"string","const":"2"},"name":{"type":"string","minLength":1,"maxLength":120},"colors":{"type":"object","properties":{"primary":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"secondary":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"accent":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"background":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"text":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"palette":{"maxItems":8,"type":"array","items":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"}}},"required":["primary"],"additionalProperties":false},"typography":{"type":"object","properties":{"heading":{"type":"string","minLength":1,"maxLength":80},"body":{"type":"string","minLength":1,"maxLength":80}},"required":["heading","body"],"additionalProperties":false},"logoArtifactIds":{"default":[],"maxItems":4,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"voiceId":{"type":"string","minLength":1,"maxLength":100},"doNotRules":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":200}},"writing":{"default":{"tone":[],"terminology":[],"examples":[]},"type":"object","properties":{"tone":{"default":[],"maxItems":12,"type":"array","items":{"type":"string","minLength":1,"maxLength":120}},"audience":{"type":"string","minLength":1,"maxLength":1000},"terminology":{"default":[],"maxItems":30,"type":"array","items":{"type":"string","minLength":1,"maxLength":200}},"examples":{"default":[],"maxItems":8,"type":"array","items":{"type":"string","minLength":1,"maxLength":1000}}},"required":["tone","terminology","examples"],"additionalProperties":false},"layout":{"default":{"spacing":[]},"type":"object","properties":{"description":{"type":"string","minLength":1,"maxLength":4000},"spacing":{"default":[],"maxItems":16,"type":"array","items":{"type":"string","minLength":1,"maxLength":120}},"corners":{"type":"string","minLength":1,"maxLength":120},"buttons":{"type":"string","minLength":1,"maxLength":1000},"imagery":{"type":"string","minLength":1,"maxLength":1000},"responsive":{"type":"string","minLength":1,"maxLength":1000},"documentTemplate":{"type":"string","minLength":1,"maxLength":4000},"presentationTemplate":{"type":"string","minLength":1,"maxLength":4000},"spreadsheetTemplate":{"type":"string","minLength":1,"maxLength":4000},"adTemplate":{"type":"string","minLength":1,"maxLength":4000},"websiteTemplate":{"type":"string","minLength":1,"maxLength":4000}},"required":["spacing"],"additionalProperties":false},"evidence":{"default":{"sources":[],"gaps":[]},"type":"object","properties":{"sourceUrl":{"type":"string","maxLength":2048,"format":"uri"},"finalUrl":{"type":"string","maxLength":2048,"format":"uri"},"observedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"sources":{"default":[],"maxItems":30,"type":"array","items":{"type":"object","properties":{"url":{"type":"string","maxLength":2048,"format":"uri"},"observation":{"type":"string","minLength":1,"maxLength":2000}},"required":["url","observation"],"additionalProperties":false}},"gaps":{"default":[],"maxItems":30,"type":"array","items":{"type":"string","minLength":1,"maxLength":500}}},"required":["sources","gaps"],"additionalProperties":false},"assetUsage":{"$ref":"#/components/schemas/AlphaDocumentAssetUsage"},"overrides":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["name","colors","typography","logoArtifactIds","voiceId","doNotRules","writing","layout","assetUsage"]},"action":{"type":"string","enum":["set","remove"]},"source":{"type":"string","enum":["customer","import"]}},"required":["field","action","source"],"additionalProperties":false}}},"required":["version","name","colors","typography","logoArtifactIds","doNotRules","writing","layout","evidence","assetUsage","overrides"],"additionalProperties":false},{"type":"object","properties":{"version":{"type":"string","const":"3"},"name":{"type":"string","minLength":1,"maxLength":120},"colors":{"type":"object","properties":{"primary":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"secondary":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"accent":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"background":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"surface":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"text":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"mutedText":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"border":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"success":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"warning":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"error":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"palette":{"maxItems":8,"type":"array","items":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"}}},"required":["primary"],"additionalProperties":false},"typography":{"type":"object","properties":{"heading":{"type":"string","minLength":1,"maxLength":80},"body":{"type":"string","minLength":1,"maxLength":80},"mono":{"type":"string","minLength":1,"maxLength":80},"scale":{"default":[],"maxItems":16,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,31}$"},"family":{"type":"string","enum":["heading","body","mono"]},"weight":{"type":"integer","minimum":100,"maximum":900},"sizePx":{"type":"number","exclusiveMinimum":0,"maximum":400},"lineHeight":{"type":"number","minimum":0.5,"maximum":4},"letterSpacingEm":{"type":"number","minimum":-0.5,"maximum":1}},"required":["name","family","weight","sizePx","lineHeight"],"additionalProperties":false}}},"required":["heading","body","scale"],"additionalProperties":false},"logoArtifactIds":{"default":[],"maxItems":4,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"voiceId":{"type":"string","minLength":1,"maxLength":100},"doNotRules":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":200}},"writing":{"default":{"tone":[],"terminology":[],"examples":[],"vocabulary":{"use":[],"avoid":[]}},"type":"object","properties":{"tone":{"default":[],"maxItems":12,"type":"array","items":{"type":"string","minLength":1,"maxLength":120}},"audience":{"type":"string","minLength":1,"maxLength":1000},"terminology":{"default":[],"maxItems":30,"type":"array","items":{"type":"string","minLength":1,"maxLength":200}},"examples":{"default":[],"maxItems":8,"type":"array","items":{"type":"string","minLength":1,"maxLength":1000}},"vocabulary":{"default":{"use":[],"avoid":[]},"type":"object","properties":{"use":{"default":[],"maxItems":40,"type":"array","items":{"type":"object","properties":{"term":{"type":"string","minLength":1,"maxLength":120},"note":{"type":"string","minLength":1,"maxLength":300}},"required":["term"],"additionalProperties":false}},"avoid":{"default":[],"maxItems":40,"type":"array","items":{"type":"object","properties":{"term":{"type":"string","minLength":1,"maxLength":120},"note":{"type":"string","minLength":1,"maxLength":300},"instead":{"type":"string","minLength":1,"maxLength":120}},"required":["term"],"additionalProperties":false}}},"required":["use","avoid"],"additionalProperties":false}},"required":["tone","terminology","examples","vocabulary"],"additionalProperties":false},"layout":{"default":{"spacing":[]},"type":"object","properties":{"description":{"type":"string","minLength":1,"maxLength":4000},"spacing":{"default":[],"maxItems":16,"type":"array","items":{"type":"string","minLength":1,"maxLength":120}},"corners":{"type":"string","minLength":1,"maxLength":120},"buttons":{"type":"string","minLength":1,"maxLength":1000},"imagery":{"type":"string","minLength":1,"maxLength":1000},"responsive":{"type":"string","minLength":1,"maxLength":1000}},"required":["spacing"],"additionalProperties":false},"guidance":{"default":{},"type":"object","properties":{"document":{"type":"string","minLength":1,"maxLength":4000},"presentation":{"type":"string","minLength":1,"maxLength":4000},"spreadsheet":{"type":"string","minLength":1,"maxLength":4000},"ad":{"type":"string","minLength":1,"maxLength":4000},"website":{"type":"string","minLength":1,"maxLength":4000}},"additionalProperties":false},"tokens":{"default":{"spacing":[],"radii":[],"components":[]},"type":"object","properties":{"spacing":{"default":[],"maxItems":16,"type":"array","items":{"type":"number","exclusiveMinimum":0,"maximum":512}},"radii":{"default":[],"maxItems":12,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,31}$"},"px":{"type":"number","minimum":0,"maximum":9999}},"required":["name","px"],"additionalProperties":false}},"components":{"default":[],"maxItems":24,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,31}$"},"description":{"type":"string","minLength":1,"maxLength":300},"background":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"foreground":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"border":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"borderWidthPx":{"type":"number","minimum":0,"maximum":16},"radiusPx":{"type":"number","minimum":0,"maximum":9999},"paddingYPx":{"type":"number","minimum":0,"maximum":256},"paddingXPx":{"type":"number","minimum":0,"maximum":256},"typeStep":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,31}$"}},"required":["name"],"additionalProperties":false}}},"required":["spacing","radii","components"],"additionalProperties":false},"claims":{"default":[],"maxItems":50,"type":"array","items":{"type":"object","properties":{"claim":{"type":"string","minLength":1,"maxLength":500},"proof":{"type":"string","minLength":1,"maxLength":1000},"proofUrl":{"type":"string","maxLength":2048,"format":"uri"},"expiresOn":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"}},"required":["claim","proof"],"additionalProperties":false}},"evidence":{"default":{"sources":[],"gaps":[]},"type":"object","properties":{"sourceUrl":{"type":"string","maxLength":2048,"format":"uri"},"finalUrl":{"type":"string","maxLength":2048,"format":"uri"},"observedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"sources":{"default":[],"maxItems":30,"type":"array","items":{"type":"object","properties":{"url":{"type":"string","maxLength":2048,"format":"uri"},"observation":{"type":"string","minLength":1,"maxLength":2000}},"required":["url","observation"],"additionalProperties":false}},"gaps":{"default":[],"maxItems":30,"type":"array","items":{"type":"string","minLength":1,"maxLength":500}}},"required":["sources","gaps"],"additionalProperties":false},"assetUsage":{"$ref":"#/components/schemas/AlphaDocumentAssetUsage"},"overrides":{"default":[],"maxItems":12,"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["name","colors","typography","logoArtifactIds","voiceId","doNotRules","writing","layout","assetUsage","guidance","tokens","claims"]},"action":{"type":"string","enum":["set","remove"]},"source":{"type":"string","enum":["customer","import"]}},"required":["field","action","source"],"additionalProperties":false}}},"required":["version","name","colors","typography","logoArtifactIds","doNotRules","writing","layout","guidance","tokens","claims","evidence","assetUsage","overrides"],"additionalProperties":false}]},"origin":{"type":"string","enum":["extraction","manual","chat"]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["kitId","kitKey","artifactId","revision","parentArtifactId","document","origin","createdAt"],"additionalProperties":false},{"type":"null"}]},"AlphaDocumentAssetUsage":{"default":[],"maxItems":64,"type":"array","items":{"type":"object","properties":{"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"role":{"type":"string","enum":["logo","logo_dark","icon","image","font_heading","font_body","screenshot","template","reference"]},"mediaType":{"type":"string","enum":["application/vnd.openxmlformats-officedocument.wordprocessingml.document","application/vnd.openxmlformats-officedocument.presentationml.presentation","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","application/pdf","application/vnd.openxmlformats-officedocument.presentationml.template","application/vnd.openxmlformats-officedocument.wordprocessingml.template","image/png","image/jpeg","image/webp","image/svg+xml","font/woff","font/woff2","font/ttf","font/otf"]},"label":{"type":"string","minLength":1,"maxLength":160},"sourceUrl":{"type":"string","maxLength":2048,"format":"uri"},"usage":{"type":"string","enum":["reference_only","web","embed","unavailable"]},"restriction":{"type":"string","minLength":1,"maxLength":500},"licence":{"type":"object","properties":{"basis":{"type":"string","const":"customer_asserted"},"assertedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["basis"],"additionalProperties":false}},"required":["artifactId","role","label","usage"],"additionalProperties":false}},"AlphaKits":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"kitKey":{"type":"string"},"name":{"type":"string"},"sourceUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","enum":["active","retired"]},"version":{"type":"integer","minimum":0,"maximum":9007199254740991},"currentRevisionArtifactId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"listStatus":{"type":"string","enum":["default","active","retired"]}},"required":["id","kitKey","name","sourceUrl","status","version","currentRevisionArtifactId","createdAt","updatedAt","listStatus"],"additionalProperties":false}},"AlphaData":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"runId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"outcome":{"anyOf":[{"type":"string","enum":["published","candidate","unavailable","failed"]},{"type":"null"}]},"failureCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"error":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"completedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"executionStatus":{"anyOf":[{"type":"string","enum":["scheduled","waiting","running","completed","failed","cancelled"]},{"type":"null"}]}},"required":["runId","outcome","failureCode","error","createdAt","completedAt","executionStatus"],"additionalProperties":false}},"AlphaWriting":{"default":{"tone":[],"terminology":[],"examples":[],"vocabulary":{"use":[],"avoid":[]}},"type":"object","properties":{"tone":{"default":[],"maxItems":12,"type":"array","items":{"type":"string","minLength":1,"maxLength":120}},"audience":{"type":"string","minLength":1,"maxLength":1000},"terminology":{"default":[],"maxItems":30,"type":"array","items":{"type":"string","minLength":1,"maxLength":200}},"examples":{"default":[],"maxItems":8,"type":"array","items":{"type":"string","minLength":1,"maxLength":1000}},"vocabulary":{"default":{"use":[],"avoid":[]},"type":"object","properties":{"use":{"default":[],"maxItems":40,"type":"array","items":{"type":"object","properties":{"term":{"type":"string","minLength":1,"maxLength":120},"note":{"type":"string","minLength":1,"maxLength":300}},"required":["term"],"additionalProperties":false}},"avoid":{"default":[],"maxItems":40,"type":"array","items":{"type":"object","properties":{"term":{"type":"string","minLength":1,"maxLength":120},"note":{"type":"string","minLength":1,"maxLength":300},"instead":{"type":"string","minLength":1,"maxLength":120}},"required":["term"],"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false},"AlphaTokens":{"default":{"spacing":[],"radii":[],"components":[]},"type":"object","properties":{"spacing":{"default":[],"maxItems":16,"type":"array","items":{"type":"number","exclusiveMinimum":0,"maximum":512}},"radii":{"default":[],"maxItems":12,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,31}$"},"px":{"type":"number","minimum":0,"maximum":9999}},"required":["name","px"],"additionalProperties":false}},"components":{"default":[],"maxItems":24,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,31}$"},"description":{"type":"string","minLength":1,"maxLength":300},"background":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"foreground":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"border":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"borderWidthPx":{"type":"number","minimum":0,"maximum":16},"radiusPx":{"type":"number","minimum":0,"maximum":9999},"paddingYPx":{"type":"number","minimum":0,"maximum":256},"paddingXPx":{"type":"number","minimum":0,"maximum":256},"typeStep":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,31}$"}},"required":["name"],"additionalProperties":false}}},"additionalProperties":false},"AlphaFiles":{"maxItems":64,"type":"array","items":{"type":"object","properties":{"fileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"mediaType":{"type":"string","enum":["application/vnd.openxmlformats-officedocument.wordprocessingml.document","application/vnd.openxmlformats-officedocument.presentationml.presentation","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","application/pdf","application/vnd.openxmlformats-officedocument.presentationml.template","application/vnd.openxmlformats-officedocument.wordprocessingml.template","image/png","image/jpeg","image/webp","image/svg+xml","font/woff","font/woff2","font/ttf","font/otf"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"artifactId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The stored file once its upload is claimed: name it in alpha.brand-kits.update.v2's assetUsage to place a file that needs a decision."},"status":{"type":"string","enum":["uploading","identifying","added","needs_decision","refused"]},"role":{"anyOf":[{"type":"string","enum":["logo","logo_dark","icon","image","font_heading","font_body","screenshot","template","reference"]},{"type":"null"}],"description":"The role an added file joined the kit as."},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Why a file needs a decision: the model's own reason, or that it could not be identified."},"refusal":{"anyOf":[{"type":"string","enum":["media_type_unsupported","size_invalid","kit_full","already_in_kit","kit_unavailable","not_uploaded","bytes_mismatch","template_hazard"]},{"type":"null"}]},"refusalDetail":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["fileId","name","mediaType","byteLength","artifactId","status","role","label","reason","refusal","refusalDetail"],"additionalProperties":false}},"AlphaFindingsItem":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"text_overflow"},"variantId":{"type":"string","minLength":1,"maxLength":80},"layerIndex":{"type":"integer","minimum":0,"maximum":9007199254740991},"layerId":{"type":"string","minLength":1,"maxLength":80},"fontSize":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"width":{"type":"object","properties":{"available":{"type":"integer","minimum":0,"maximum":9007199254740991},"needed":{"type":"integer","minimum":0,"maximum":9007199254740991},"lines":{"type":"array","items":{"type":"integer","minimum":0,"maximum":9007199254740991}}},"required":["available","needed","lines"],"additionalProperties":false},"height":{"type":"object","properties":{"available":{"type":"integer","minimum":0,"maximum":9007199254740991},"needed":{"type":"integer","minimum":0,"maximum":9007199254740991},"linesShown":{"type":"integer","minimum":0,"maximum":9007199254740991},"lines":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["available","needed","linesShown","lines"],"additionalProperties":false}},"required":["kind","variantId","layerIndex","fontSize"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"text_shrunk"},"variantId":{"type":"string","minLength":1,"maxLength":80},"layerIndex":{"type":"integer","minimum":0,"maximum":9007199254740991},"layerId":{"type":"string","minLength":1,"maxLength":80},"requestedFontSize":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"appliedFontSize":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"minFontSize":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["kind","variantId","layerIndex","requestedFontSize","appliedFontSize","minFontSize"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"text_fit_stopped"},"variantId":{"type":"string","minLength":1,"maxLength":80},"layerIndex":{"type":"integer","minimum":0,"maximum":9007199254740991},"layerId":{"type":"string","minLength":1,"maxLength":80},"reason":{"type":"string","enum":["probe_limit","call_budget"],"description":"probe_limit: this layer's sizing search used its tries; call_budget: this call's shrink renders ran out."},"appliedFontSize":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["kind","variantId","layerIndex","reason","appliedFontSize"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"safe_area"},"variantId":{"type":"string","minLength":1,"maxLength":80},"layerIndex":{"type":"integer","minimum":0,"maximum":9007199254740991},"layerId":{"type":"string","minLength":1,"maxLength":80},"overlap":{"type":"object","properties":{"top":{"type":"integer","minimum":0,"maximum":9007199254740991},"right":{"type":"integer","minimum":0,"maximum":9007199254740991},"bottom":{"type":"integer","minimum":0,"maximum":9007199254740991},"left":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["top","right","bottom","left"],"additionalProperties":false}},"required":["kind","variantId","layerIndex","overlap"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"contrast"},"variantId":{"type":"string","minLength":1,"maxLength":80},"layerIndex":{"type":"integer","minimum":0,"maximum":9007199254740991},"layerId":{"type":"string","minLength":1,"maxLength":80},"ratio":{"type":"number","minimum":1,"maximum":21},"required":{"anyOf":[{"type":"number","const":4.5},{"type":"number","const":3}]},"fontSize":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"textColor":{"type":"string","pattern":"^#[a-fA-F0-9]{6}$"},"backgroundColor":{"type":"string","pattern":"^#[a-fA-F0-9]{6}$"}},"required":["kind","variantId","layerIndex","ratio","required","fontSize","textColor","backgroundColor"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"recommended_length"},"variantId":{"type":"string","minLength":1,"maxLength":80},"presetId":{"type":"string","minLength":1,"maxLength":80},"field":{"type":"string","enum":["headline","body"]},"length":{"type":"integer","minimum":0,"maximum":9007199254740991},"recommended":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["kind","variantId","presetId","field","length","recommended"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"recommended_size"},"variantId":{"type":"string","minLength":1,"maxLength":80},"presetId":{"type":"string","minLength":1,"maxLength":80},"width":{"type":"integer","minimum":0,"maximum":9007199254740991},"height":{"type":"integer","minimum":0,"maximum":9007199254740991},"recommended":{"type":"object","properties":{"width":{"type":"integer","minimum":0,"maximum":9007199254740991},"height":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["width","height"],"additionalProperties":false}},"required":["kind","variantId","presetId","width","height","recommended"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"image_asset"},"variantId":{"type":"string","minLength":1,"maxLength":80},"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"field":{"type":"string","enum":["image","logo"]},"aspectRatio":{"type":"string","minLength":1,"maxLength":80},"width":{"type":"integer","minimum":0,"maximum":9007199254740991},"height":{"type":"integer","minimum":0,"maximum":9007199254740991},"byteLength":{"type":"integer","minimum":0,"maximum":9007199254740991},"issues":{"minItems":1,"type":"array","items":{"type":"string","enum":["ratio_mismatch","below_minimum","over_max_bytes","unreadable"]}}},"required":["kind","variantId","artifactId","field","aspectRatio","byteLength","issues"],"additionalProperties":false}]},"AlphaEntries":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","minLength":1,"description":"Path of the member inside the archive"},"contentType":{"type":"string","minLength":1},"byteLength":{"type":"integer","minimum":0,"maximum":9007199254740991},"url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Presigned GET URL for a stored member; null for inline content"},"expiresAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}],"description":"When url stops working (minutes after the call); null with url"},"content":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The member's content when generated inline"},"encoding":{"anyOf":[{"type":"string","enum":["utf8","base64"]},{"type":"null"}],"description":"Encoding of content"}},"required":["path","contentType","byteLength","url","expiresAt","content","encoding"],"additionalProperties":false}},"AlphaDataItem":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"product":{"type":"string","enum":["discovery","experience"]},"campaign":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"rank":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"priorityScore":{"type":"number"},"title":{"type":"string"},"context":{"type":"string"},"action":{"type":"string"},"area":{"type":"string","enum":["product","content","distribution","pricing_packaging","compliance_security","sales_enablement","competitive_positioning","customer_success","operations"]},"status":{"type":"string","enum":["acknowledged","in_progress","done","dismissed"]},"suggestedBy":{"type":"string"},"reach":{"type":"object","properties":{"pct":{"type":"number"},"rationale":{"type":"string"}},"required":["pct","rationale"],"additionalProperties":false},"effort":{"type":"object","properties":{"level":{"type":"string","enum":["low","medium","high"]},"score":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"rationale":{"type":"string"},"primaryConstraint":{"type":"string"}},"required":["level","score","rationale","primaryConstraint"],"additionalProperties":false},"upside":{"type":"object","properties":{"expectedFinalWins":{"type":"number"},"measuredConversations":{"type":"number"},"expectedPassedJourneys":{"type":"number"},"passRateJourneys":{"type":"number"},"lossReductionPct":{"type":"number"},"winRateLiftPp":{"type":"number"},"brandShareLiftPp":{"type":"number"},"blendedLiftPp":{"type":"number"},"primaryMetric":{"type":"string","enum":["win_rate","brand_share","both"]},"rationale":{"type":"string"}},"required":["lossReductionPct","winRateLiftPp","brandShareLiftPp","blendedLiftPp","primaryMetric","rationale"],"additionalProperties":false},"impact":{"type":"object","properties":{"metric":{"type":"string","enum":["win_rate","site_pass_rate"]},"liftPp":{"type":"number"},"annualValueUsd":{"anyOf":[{"type":"number"},{"type":"null"}]},"basis":{"type":"string","const":"model_estimate"}},"required":["metric","liftPp","annualValueUsd","basis"],"additionalProperties":false},"expectedAnnualValueUsd":{"anyOf":[{"type":"number"},{"type":"null"}]},"estimatedTimeline":{"type":"string"},"evidenceSummary":{"type":"string"},"evidence":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["win_reason","loss_reason","positive_sentiment","negative_sentiment","decision_criterion","competitor_action","source_evidence","citation","measurement"]},"label":{"type":"string"},"count":{"type":"number"},"competitor":{"type":"string"},"source":{"type":"string"},"metric":{"type":"string"},"value":{"type":"number"}},"required":["kind","label"],"additionalProperties":false}},"evidenceCitations":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["aggregate_metric","brand_measurement","source_evidence","source_influence","conversation","citation"]},"summary":{"type":"string"},"factLabel":{"type":"string"},"analysisId":{"type":"string"},"conversationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"metric":{"type":"string"},"value":{"type":"number"},"count":{"type":"number"},"source":{"type":"string"},"url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["kind","summary"],"additionalProperties":false}},"evidenceLinks":{"type":"array","items":{"type":"object","properties":{"routeId":{"type":"string"},"label":{"type":"string"},"href":{"type":"string"},"reason":{"type":"string"}},"required":["routeId","label","href","reason"],"additionalProperties":false}},"dismissalReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"raisedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"carriedRefreshCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"latestDecision":{"$ref":"#/components/schemas/AlphaLatestDecision"},"outcome":{"$ref":"#/components/schemas/AlphaLatestDecision"},"planRun":{"anyOf":[{"type":"object","properties":{"conversationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"failed":{"type":"boolean"}},"required":["conversationId","failed"],"additionalProperties":false},{"type":"null"}]},"implementation":{"$ref":"#/components/schemas/AlphaImplementation"},"review":{"$ref":"#/components/schemas/AlphaReview"}},"required":["id","product","campaign","rank","priorityScore","title","context","action","area","status","suggestedBy","reach","effort","upside","impact","expectedAnnualValueUsd","estimatedTimeline","evidenceSummary","evidence","evidenceCitations","evidenceLinks","dismissalReason","raisedAt","completedAt","carriedRefreshCount","latestDecision","outcome","planRun","implementation","review"],"additionalProperties":false},"AlphaLatestDecision":{"anyOf":[{"type":"object","properties":{"dispatchId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"decidedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"decision":{"type":"string","enum":["keep","drop","unsupported","outcome"]},"reason":{"type":"string"},"verdict":{"anyOf":[{"type":"string","enum":["worked","didnt","too_early","cant_tell"]},{"type":"null"}]},"observation":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["dispatchId","decidedAt","decision","reason","verdict","observation"],"additionalProperties":false},{"type":"null"}]},"AlphaImplementation":{"anyOf":[{"type":"object","properties":{"statusControl":{"type":"string","enum":["automatic","manual"]},"latest":{"anyOf":[{"type":"object","properties":{"checkId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"observedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"finding":{"type":"string","enum":["confirmed","partial","not_seen","unavailable","removed","already_present","manual"]},"summary":{"type":"string"},"criteria":{"type":"array","items":{"type":"object","properties":{"criterionId":{"type":"string"},"requirement":{"anyOf":[{"type":"string"},{"type":"null"}]},"scope":{"anyOf":[{"type":"string"},{"type":"null"}]},"assessment":{"type":"string","enum":["met","missing","unknown"]},"quote":{"anyOf":[{"type":"string"},{"type":"null"}]},"explanation":{"type":"string"},"sourceUrls":{"type":"array","items":{"type":"string"}}},"required":["criterionId","requirement","scope","assessment","quote","explanation","sourceUrls"],"additionalProperties":false}},"missingOrUncertainScope":{"type":"array","items":{"type":"string"}},"change":{"anyOf":[{"type":"string"},{"type":"null"}]},"sources":{"$ref":"#/components/schemas/AlphaSources"},"application":{"type":"string","enum":["applied","no_effect","superseded"]},"applicationReason":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["checkId","observedAt","finding","summary","criteria","missingOrUncertainScope","change","sources","application","applicationReason"],"additionalProperties":false},{"type":"null"}]},"completedBy":{"anyOf":[{"type":"object","properties":{"checkId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["checkId","at"],"additionalProperties":false},{"type":"null"}]},"reviewWarning":{"type":"boolean"}},"required":["statusControl","latest","completedBy","reviewWarning"],"additionalProperties":false},{"type":"null"}]},"AlphaSources":{"type":"array","items":{"type":"object","properties":{"evidenceId":{"type":"string","minLength":1,"maxLength":40},"requestedUrl":{"type":"string","maxLength":2048,"format":"uri"},"finalUrl":{"anyOf":[{"type":"string","maxLength":2048,"format":"uri"},{"type":"null"}]},"status":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"fetchedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"byteLength":{"type":"integer","minimum":0,"maximum":9007199254740991},"sha256":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{64}$"},{"type":"null"}]},"truncated":{"type":"boolean"},"error":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},"required":["evidenceId","requestedUrl","finalUrl","status","fetchedAt","byteLength","sha256","truncated","error"],"additionalProperties":false}},"AlphaReview":{"type":"object","properties":{"section":{"type":"string","enum":["new","reviewed","set_aside"]},"why":{"anyOf":[{"type":"string"},{"type":"null"}]},"groupLead":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"title":{"type":"string"}},"required":["id","title"],"additionalProperties":false},{"type":"null"}]},"groupMembers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"title":{"type":"string"}},"required":["id","title"],"additionalProperties":false}}},"required":["section","why","groupLead","groupMembers"],"additionalProperties":false},"AlphaCampaign":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"product":{"type":"string","enum":["discovery","experience"],"description":"The product whose campaign it is"},"dispatchId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The campaign's newest publication (a Discovery dispatch or an Experience cycle); create.v1 and create.v2 accept it and no longer read it"}},"required":["id","name","product","dispatchId"],"additionalProperties":false},{"type":"null"}],"description":"The campaign the list is scoped to: the one named, or the organization's only campaign; null across the organization"},"AlphaDataItem2":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"product":{"type":"string","enum":["discovery","experience"]},"campaign":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"rank":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"priorityScore":{"type":"number"},"title":{"type":"string"},"context":{"type":"string"},"action":{"type":"string"},"area":{"type":"string","enum":["product","content","distribution","pricing_packaging","compliance_security","sales_enablement","competitive_positioning","customer_success","operations"]},"status":{"type":"string","enum":["acknowledged","in_progress","done","dismissed"]},"suggestedBy":{"type":"string"},"reach":{"type":"object","properties":{"pct":{"type":"number"},"rationale":{"type":"string"}},"required":["pct","rationale"],"additionalProperties":false},"effort":{"type":"object","properties":{"level":{"type":"string","enum":["low","medium","high"]},"score":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"rationale":{"type":"string"},"primaryConstraint":{"type":"string"}},"required":["level","score","rationale","primaryConstraint"],"additionalProperties":false},"upside":{"type":"object","properties":{"expectedFinalWins":{"type":"number"},"measuredConversations":{"type":"number"},"expectedPassedJourneys":{"type":"number"},"passRateJourneys":{"type":"number"},"lossReductionPct":{"type":"number"},"winRateLiftPp":{"type":"number"},"brandShareLiftPp":{"type":"number"},"blendedLiftPp":{"type":"number"},"primaryMetric":{"type":"string","enum":["win_rate","brand_share","both","site_pass_rate"]},"rationale":{"type":"string"}},"required":["lossReductionPct","winRateLiftPp","brandShareLiftPp","blendedLiftPp","primaryMetric","rationale"],"additionalProperties":false},"impact":{"type":"object","properties":{"metric":{"type":"string","enum":["win_rate","site_pass_rate"]},"liftPp":{"type":"number"},"annualValueUsd":{"anyOf":[{"type":"number"},{"type":"null"}]},"basis":{"type":"string","const":"model_estimate"}},"required":["metric","liftPp","annualValueUsd","basis"],"additionalProperties":false},"expectedAnnualValueUsd":{"anyOf":[{"type":"number"},{"type":"null"}]},"estimatedTimeline":{"type":"string"},"evidenceSummary":{"type":"string"},"evidence":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["win_reason","loss_reason","positive_sentiment","negative_sentiment","decision_criterion","competitor_action","source_evidence","citation","measurement"]},"label":{"type":"string"},"count":{"type":"number"},"competitor":{"type":"string"},"source":{"type":"string"},"metric":{"type":"string"},"value":{"type":"number"}},"required":["kind","label"],"additionalProperties":false}},"evidenceCitations":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["aggregate_metric","brand_measurement","source_evidence","source_influence","conversation","citation","journey"]},"summary":{"type":"string"},"factLabel":{"type":"string"},"analysisId":{"type":"string"},"conversationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"metric":{"type":"string"},"value":{"type":"number"},"count":{"type":"number"},"source":{"type":"string"},"url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["kind","summary"],"additionalProperties":false}},"evidenceLinks":{"type":"array","items":{"type":"object","properties":{"routeId":{"type":"string"},"label":{"type":"string"},"href":{"type":"string"},"reason":{"type":"string"}},"required":["routeId","label","href","reason"],"additionalProperties":false}},"dismissalReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"raisedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"carriedRefreshCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"latestDecision":{"$ref":"#/components/schemas/AlphaLatestDecision"},"outcome":{"$ref":"#/components/schemas/AlphaLatestDecision"},"planRun":{"anyOf":[{"type":"object","properties":{"conversationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"failed":{"type":"boolean"}},"required":["conversationId","failed"],"additionalProperties":false},{"type":"null"}]},"implementation":{"$ref":"#/components/schemas/AlphaImplementation"},"review":{"$ref":"#/components/schemas/AlphaReview"}},"required":["id","product","campaign","rank","priorityScore","title","context","action","area","status","suggestedBy","reach","effort","upside","impact","expectedAnnualValueUsd","estimatedTimeline","evidenceSummary","evidence","evidenceCitations","evidenceLinks","dismissalReason","raisedAt","completedAt","carriedRefreshCount","latestDecision","outcome","planRun","implementation","review"],"additionalProperties":false},"AlphaDataItem3":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"section":{"anyOf":[{"type":"string","enum":["awaiting_review","listed","set_aside"]},{"type":"null"}],"description":"awaiting_review: open and not yet ordered by the published review (new or changed since it read the list), or any action before the first review; listed: on its order, or, with no position, done or dismissed and not placed by it; set_aside: set aside by an older review, until a review places it again. Null when the action is off the list (retired or merged by an older review, or every live evidence link's campaign has left)"},"position":{"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"null"}],"description":"Its place in the published review's order; null while awaiting review, once done or dismissed and not placed by it, or off the list"},"why":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The published review's one sentence why it is placed so"},"reviewId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The published review that placed it"},"state":{"type":"string","enum":["acknowledged","in_progress","done","dismissed"],"description":"acknowledged is Open; done is Completed"},"status":{"type":"string","enum":["open","completed","dismissed"]},"statusControl":{"type":"string","enum":["automatic","manual"],"description":"automatic: a review may revise or dismiss it; manual: a person or API key set it, and a review never revises or dismisses it. A review may complete, reopen or resurface either"},"disposition":{"type":"string","enum":["active","set_aside","retired","merged"]},"mergedIntoId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The action an older review merged it into"},"actionRevision":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Advances with every change; update.v2's expectedRevision names it"},"revision":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ordinal":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["id","ordinal"],"additionalProperties":false,"description":"Its current content revision"},"content":{"$ref":"#/components/schemas/AlphaContent"},"valueUsd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The opportunity its expected effect stands for a year on the revenue lines it names, where Advisor priced it: on a campaign, a share of those lines' AI-influenced market, not the company's revenue, so it can exceed the brand's own sales; on a site Inspector measures, the brand's own sales on those lines that its mobile speed moves"},"valueUnpriced":{"anyOf":[{"type":"string","enum":["no_expected_effect","no_estimate","not_an_increase","unit_unpriced","metric_unpriced","no_campaign","not_measured","no_revenue_economics"]},{"type":"null"}],"description":"Why it has no dollar value, where a review said: no_expected_effect, no_estimate, not_an_increase, unit_unpriced, metric_unpriced (no owner prices its metric), no_campaign, not_measured (nothing measured on its campaign yet to price it), or no_revenue_economics (its campaign's revenue lines have no Revenue Tracking economics); null when priced or unsaid, and when its effect names none of its campaign's priced revenue lines (its revision's valueBasis.unpriced says no_revenue_line)"},"findings":{"$ref":"#/components/schemas/AlphaFindings"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"createdByKind":{"anyOf":[{"type":"string","enum":["person","api_key","automation","review","unknown"]},{"type":"null"}]},"firstSuggestedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"lastStateChangeAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"dismissedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"dismissalReason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Why it was dismissed; null when dismissed without a reason, or not dismissed"},"latestStateChange":{"$ref":"#/components/schemas/AlphaLatestStateChange"},"implementation":{"$ref":"#/components/schemas/AlphaImplementation2"},"latestOutcome":{"$ref":"#/components/schemas/AlphaLatestOutcome"},"conversation":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The action's Ship with Alpha conversation"},"failed":{"type":"boolean","description":"Its latest turn failed (a stop is not a failure)"}},"required":["id","failed"],"additionalProperties":false},{"type":"null"}]}},"required":["id","section","position","why","reviewId","state","status","statusControl","disposition","mergedIntoId","actionRevision","revision","content","valueUsd","valueUnpriced","findings","createdAt","createdByKind","firstSuggestedAt","lastStateChangeAt","dismissedAt","dismissalReason","latestStateChange","implementation","latestOutcome","conversation"],"additionalProperties":false},"AlphaContent":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":300},"body":{"type":"string","minLength":1,"maxLength":8000},"action":{"type":"string","maxLength":4000},"area":{"type":"string","enum":["product","content","distribution","pricing_packaging","compliance_security","sales_enablement","competitive_positioning","customer_success","operations"]},"effort":{"type":"string","enum":["low","medium","high"]},"subject":{"type":"object","properties":{"sites":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"url":{"type":"string","maxLength":2048,"format":"uri"},"businessProfileId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["url","businessProfileId"],"additionalProperties":false}},"locations":{"maxItems":200,"type":"array","items":{"type":"object","properties":{"businessProfileId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"locationKey":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"label":{"type":"string","maxLength":200},"address":{"type":"string","maxLength":400},"url":{"anyOf":[{"type":"string","maxLength":2048,"format":"uri"},{"type":"null"}]}},"required":["businessProfileId","locationKey","label","address","url"],"additionalProperties":false}},"campaigns":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"product":{"type":"string","enum":["discovery","experience","inspector"]}},"required":["id","product"],"additionalProperties":false}}},"required":["sites","locations","campaigns"],"additionalProperties":false},"expectedEffect":{"anyOf":[{"type":"object","properties":{"product":{"type":"string","enum":["discovery","experience","inspector"]},"metric":{"type":"string","maxLength":100,"pattern":"^[a-z][a-z0-9]*(?:_[a-z0-9]+)*$"},"unit":{"type":"string","enum":["pp","count","ratio","usd"]},"horizon":{"type":"string","maxLength":200},"estimate":{"anyOf":[{"type":"number"},{"type":"null"}]},"low":{"anyOf":[{"type":"number"},{"type":"null"}]},"high":{"anyOf":[{"type":"number"},{"type":"null"}]},"assumptions":{"type":"string","maxLength":2000},"revenueLineIds":{"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":200}}},"required":["product","metric","unit","horizon","estimate","low","high","assumptions"],"additionalProperties":false},{"type":"null"}]},"completionCriteria":{"anyOf":[{"maxItems":20,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$","description":"A short stable key, e.g. walk_in_hours_clinic_a"},"requirement":{"type":"string","minLength":1,"maxLength":400,"description":"What must be visible on the public site, in one sentence"},"scope":{"type":"string","minLength":1,"maxLength":300,"description":"Where it must be visible: which pages, locations, or plans"}},"required":["id","requirement","scope"],"additionalProperties":false}},{"type":"null"}]}},"required":["title","body","action","area","effort","subject","expectedEffect","completionCriteria"],"additionalProperties":false},"AlphaFindings":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string","description":"One sentence"},"stance":{"type":"string","enum":["supports","against"],"description":"supports: a fact the verdict rests on; against: one that weighs against it"},"citations":{"type":"array","items":{"type":"object","properties":{"start":{"type":"integer","minimum":0,"maximum":9007199254740991},"end":{"type":"integer","minimum":0,"maximum":9007199254740991},"sources":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"row"},"product":{"type":"string","enum":["discovery","experience","inspector"]},"dataset":{"type":"string"},"rowId":{"type":"string"},"publicationId":{"type":"string"},"route":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of the page its row is seen on (e.g. discovery_conversation); null where its publication resolved none"},"href":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"That page; null where it has none"}},"required":["kind","product","dataset","rowId","publicationId","route","href"],"additionalProperties":false,"description":"An evidence row of a publication the review read"},{"type":"object","properties":{"kind":{"type":"string","const":"page"},"url":{"type":"string"},"quote":{"type":"string","description":"The words the review recorded from the page"},"capturedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"href":{"type":"string","description":"The page with the quote highlighted (a text fragment)"}},"required":["kind","url","quote","capturedAt","href"],"additionalProperties":false,"description":"A quote the review recorded from a page"}]}}},"required":["start","end","sources"],"additionalProperties":false},"description":"Each figure in the text (start and end, in UTF-16 code units) and the sources it rests on"}},"required":["text","stance","citations"],"additionalProperties":false},"description":"The facts its verdict rests on, strongest first: a review's, carried unchanged by a person's later revision; empty for an action a person created"},"AlphaLatestStateChange":{"anyOf":[{"type":"object","properties":{"actorKind":{"type":"string","enum":["person","api_key","automation","review","unknown"],"description":"Who made it"},"from":{"anyOf":[{"type":"string","enum":["acknowledged","in_progress","done","dismissed"]},{"type":"null"}],"description":"The state it left; null where none was recorded"},"to":{"type":"string","enum":["acknowledged","in_progress","done","dismissed"],"description":"The state it reached"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Why: a dismissal's reason, a person's note, or a review's one sentence; null where none was given"},"at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["actorKind","from","to","reason","at"],"additionalProperties":false},{"type":"null"}],"description":"Its newest status change, who made it and why; null when none is recorded"},"AlphaImplementation2":{"type":"object","properties":{"statusControl":{"type":"string","enum":["automatic","manual"]},"latest":{"anyOf":[{"type":"object","properties":{"checkId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"observedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"finding":{"type":"string","enum":["confirmed","partial","not_seen","unavailable","removed","already_present","manual"]},"summary":{"type":"string"},"criteria":{"type":"array","items":{"type":"object","properties":{"criterionId":{"type":"string"},"requirement":{"anyOf":[{"type":"string"},{"type":"null"}]},"scope":{"anyOf":[{"type":"string"},{"type":"null"}]},"assessment":{"type":"string","enum":["met","missing","unknown"]},"quote":{"anyOf":[{"type":"string"},{"type":"null"}]},"explanation":{"type":"string"},"sourceUrls":{"type":"array","items":{"type":"string"}}},"required":["criterionId","requirement","scope","assessment","quote","explanation","sourceUrls"],"additionalProperties":false}},"missingOrUncertainScope":{"type":"array","items":{"type":"string"}},"change":{"anyOf":[{"type":"string"},{"type":"null"}]},"sources":{"$ref":"#/components/schemas/AlphaSources"},"application":{"type":"string","enum":["applied","no_effect","superseded"]},"applicationReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"assessedRevisionId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"settledAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["checkId","observedAt","finding","summary","criteria","missingOrUncertainScope","change","sources","application","applicationReason","assessedRevisionId","settledAt"],"additionalProperties":false},{"type":"null"}]},"completedBy":{"anyOf":[{"type":"object","properties":{"checkId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["checkId","at"],"additionalProperties":false},{"type":"null"}]},"reviewWarning":{"type":"boolean"},"decidedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]}},"required":["statusControl","latest","completedBy","reviewWarning","decidedAt"],"additionalProperties":false,"description":"Implementation tracking: who decides its status and the latest website check"},"AlphaLatestOutcome":{"anyOf":[{"$ref":"#/components/schemas/AlphaLatestOutcomeVariant"},{"type":"null"}],"description":"Its newest measured metric outcome"},"AlphaLatestOutcomeVariant":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"completionEventId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"kind":{"type":"string","enum":["metric","page_traffic"],"description":"metric: a metric an evidence product owns; page_traffic: Business Outcomes' page visits"},"product":{"type":"string"},"metric":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`<product>:<metric>`; null for page traffic"},"status":{"type":"string","enum":["measured","unavailable"]},"comparison":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/JsonValue"},"description":"The periods compared, before and after"},"result":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/JsonValue"},"description":"The metric owner's numbers"},"sourceRefs":{"type":"array","items":{"$ref":"#/components/schemas/JsonValue"}},"measuredAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["id","completionEventId","kind","product","metric","status","comparison","result","sourceRefs","measuredAt"],"additionalProperties":false},"AlphaHistory":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"actorUserId":{"anyOf":[{"type":"string"},{"type":"null"}]},"actorLabel":{"anyOf":[{"type":"string"},{"type":"null"}]},"actorApiKeyId":{"anyOf":[{"type":"string"},{"type":"null"}]},"checkRunId":{"anyOf":[{"type":"string"},{"type":"null"}]},"previousState":{"anyOf":[{"type":"string","enum":["acknowledged","in_progress","done","dismissed"]},{"type":"null"}]},"state":{"anyOf":[{"type":"string","enum":["acknowledged","in_progress","done","dismissed"]},{"type":"null"}]},"dismissalReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","at","actorUserId","actorLabel","actorApiKeyId","checkRunId","previousState","state","dismissalReason","note"],"additionalProperties":false}},"AlphaFiles2":{"type":"array","items":{"type":"object","properties":{"turnId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"artifact":{"type":"object","properties":{"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"title":{"type":"string"},"kind":{"type":"string","enum":["markdown","slides","image","audio","video","brand_kit","presentation","spreadsheet","word","pdf","csv","page"]},"mediaType":{"type":"string","enum":["text/markdown","application/vnd.point11.slides+json","image/png","image/jpeg","image/webp","audio/mpeg","audio/wav","video/mp4","video/webm","application/vnd.point11.brand-kit+json","application/vnd.openxmlformats-officedocument.presentationml.presentation","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","application/vnd.openxmlformats-officedocument.wordprocessingml.document","application/pdf","text/csv","text/html","application/vnd.point11.website+json"]},"status":{"type":"string","enum":["ready","pending"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"slideCount":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"previewArtifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["artifactId","title","kind","mediaType"],"additionalProperties":false},"url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"A five-minute presigned read of the file's bytes; null when none could be issued"},"urlExpiresAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}],"description":"When `url` stops working"}},"required":["turnId","artifact","url","urlExpiresAt"],"additionalProperties":false}},"AlphaSubject":{"description":"The sites, locations and campaigns it is about; none when omitted","type":"object","properties":{"sites":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"url":{"type":"string","maxLength":2048,"format":"uri"},"businessProfileId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["url","businessProfileId"],"additionalProperties":false}},"locations":{"maxItems":200,"type":"array","items":{"type":"object","properties":{"businessProfileId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"locationKey":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"label":{"type":"string","maxLength":200},"address":{"type":"string","maxLength":400},"url":{"anyOf":[{"type":"string","maxLength":2048,"format":"uri"},{"type":"null"}]}},"required":["businessProfileId","locationKey","label","address","url"],"additionalProperties":false}},"campaigns":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"product":{"type":"string","enum":["discovery","experience","inspector"]}},"required":["id","product"],"additionalProperties":false}}},"required":["sites","locations","campaigns"],"additionalProperties":false},"AlphaMetadata":{"type":"object","properties":{"brand":{"type":"object","properties":{"profileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"unbranded":{"type":"boolean"}},"additionalProperties":false},"regenerateTurnId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"responseVersion":{"$ref":"#/components/schemas/AlphaResponseVersion"},"threadId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"turnId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"attachments":{"maxItems":5,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["text/plain","text/csv","application/json","text/markdown","text/html","application/vnd.openxmlformats-officedocument.wordprocessingml.document","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","image/png","image/jpeg","image/webp","application/pdf"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":10000000}},"required":["id","filename","mediaType","byteLength"],"additionalProperties":false}},"effort":{"type":"string","enum":["low","xhigh","max"]},"model":{"type":"string","minLength":3,"maxLength":120,"pattern":"^[a-z0-9][a-z0-9-]*\\/[A-Za-z0-9][A-Za-z0-9._:-]*$"},"analysisDurationMs":{"type":"integer","minimum":0,"maximum":9007199254740991},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"feedback":{"type":"object","properties":{"rating":{"type":"string","enum":["up","down"]},"comment":{"anyOf":[{"type":"string","minLength":1,"maxLength":2000},{"type":"null"}]},"reasons":{"type":"array","items":{"type":"string","enum":["on_brief","accurate","looks_great","on_brand","ready_to_use","off_brief","wrong_numbers","layout_problems","off_brand","hard_to_edit","missing_content","text_errors"]}},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["rating","comment","updatedAt"],"additionalProperties":false},"intent":{"type":"string","enum":["presentation","spreadsheet","document","pdf","ads","page","image"]},"adBrief":{"type":"object","properties":{"type":{"type":"string","enum":["static","search","responsive_display","landing_page"]},"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lossReasonId":{"type":"string","minLength":1,"maxLength":1000},"campaignName":{"type":"string","minLength":1,"maxLength":500},"lossReason":{"type":"string","minLength":1,"maxLength":2000}},"additionalProperties":false},"viewing":{"type":"object","properties":{"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"unit":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["slide","page"]},"index":{"type":"integer","minimum":1,"maximum":9999}},"required":["type","index"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["range","element","state"]},"text":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[^\\u0000-\\u001f\\u007f]+$"}},"required":["type","text"],"additionalProperties":false}]}},"required":["artifactId"],"additionalProperties":false},"useConnectors":{"type":"boolean","const":true},"connectorContinuation":{"type":"boolean","const":true},"asker":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":320},"mine":{"type":"boolean"}},"required":["name","mine"],"additionalProperties":false},"brief":{"type":"object","properties":{"deliverable":{"type":"string","enum":["presentation","page","ads"]},"goal":{"type":"string","minLength":1,"maxLength":300},"audience":{"type":"string","minLength":1,"maxLength":200},"outline":{"minItems":1,"maxItems":12,"type":"array","items":{"type":"string","minLength":1,"maxLength":150}},"sources":{"maxItems":6,"type":"array","items":{"type":"string","minLength":1,"maxLength":150}},"brand":{"type":"string","minLength":1,"maxLength":150},"estimate":{"type":"object","properties":{"sampleSize":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"medianDurationMs":{"type":"integer","minimum":0,"maximum":9007199254740991},"medianCredits":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["sampleSize","medianDurationMs","medianCredits"],"additionalProperties":false}},"required":["deliverable","goal","audience","outline","sources","brand"],"additionalProperties":false},"connectorCard":{"$ref":"#/components/schemas/AlphaConnectorCard"}},"required":["threadId","turnId"],"additionalProperties":false},"AlphaResponseVersion":{"type":"object","properties":{"rootTurnId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"index":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"count":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"previousTurnId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"nextTurnId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"selectable":{"type":"boolean"}},"required":["rootTurnId","index","count","previousTurnId","nextTurnId","selectable"],"additionalProperties":false},"AlphaConnectorCard":{"type":"object","properties":{"items":{"minItems":1,"maxItems":16,"type":"array","items":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"approve"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"connector":{"type":"object","properties":{"uid":{"type":"string","minLength":1,"maxLength":384},"service":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,39}$","description":"The connector's service key, such as linear"},"label":{"type":"string","minLength":1,"maxLength":80}},"required":["uid","service","label"],"additionalProperties":false},"action":{"type":"object","properties":{"name":{"type":"string","maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:/-]*$","description":"The action's name as the service lists it, such as create_issue"},"title":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]}},"required":["name","title"],"additionalProperties":false},"input":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/JsonValue"}},"inputLabels":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":64},"additionalProperties":{"type":"string","minLength":1,"maxLength":200}},"account":{"anyOf":[{"type":"string","minLength":1,"maxLength":320},{"type":"null"}]},"accountKey":{"type":"string","minLength":1,"maxLength":128},"destructive":{"type":"boolean"},"alwaysAllowOffered":{"type":"boolean"}},"required":["kind","id","connector","action","input","account","destructive","alwaysAllowOffered"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"blocked"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"connector":{"type":"object","properties":{"uid":{"type":"string","minLength":1,"maxLength":384},"service":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,39}$","description":"The connector's service key, such as linear"},"label":{"type":"string","minLength":1,"maxLength":80}},"required":["uid","service","label"],"additionalProperties":false},"action":{"anyOf":[{"type":"object","properties":{"name":{"type":"string","maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:/-]*$","description":"The action's name as the service lists it, such as create_issue"},"title":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]}},"required":["name","title"],"additionalProperties":false},{"type":"null"}]},"reason":{"type":"string","minLength":1,"maxLength":1000},"input":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/JsonValue"}},{"type":"null"}]},"inputLabels":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":64},"additionalProperties":{"type":"string","minLength":1,"maxLength":200}},"account":{"anyOf":[{"type":"string","minLength":1,"maxLength":320},{"type":"null"}]},"accountKey":{"type":"string","minLength":1,"maxLength":128},"askerCanManage":{"type":"boolean"}},"required":["kind","id","connector","action","reason","input","account","askerCanManage"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"connect"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"connector":{"type":"object","properties":{"uid":{"type":"string","minLength":1,"maxLength":384},"service":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,39}$","description":"The connector's service key, such as linear"},"label":{"type":"string","minLength":1,"maxLength":80}},"required":["uid","service","label"],"additionalProperties":false},"reason":{"type":"string","minLength":1,"maxLength":1000}},"required":["kind","id","connector","reason"],"additionalProperties":false}]}}},"required":["items"],"additionalProperties":false},"AlphaParts":{"type":"object","properties":{"type":{"type":"string","const":"data-evidence"},"data":{"type":"object","properties":{"queries":{"type":"array","items":{"type":"object","properties":{"purpose":{"type":"string","minLength":1,"maxLength":500},"sql":{"type":"string","minLength":1,"maxLength":30000},"rowCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"truncated":{"type":"boolean"},"columns":{"maxItems":200,"type":"array","items":{"type":"string"}},"durationMs":{"type":"integer","minimum":0,"maximum":9007199254740991},"resultBytes":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["purpose","rowCount","truncated","columns"],"additionalProperties":false}},"connectorCalls":{"type":"array","items":{"type":"object","properties":{"connector":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,127}\\/[a-zA-Z0-9][a-zA-Z0-9._/-]{0,255}$"},"tool":{"type":"string","maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:/-]*$"},"status":{"type":"string","enum":["ok","error"]},"reason":{"type":"string","enum":["member_always_allow","org_allow","approved_once","admin_approved_once"]}},"required":["connector","tool","status"],"additionalProperties":false}},"createCalls":{"type":"array","items":{"type":"object","properties":{"tool":{"type":"string","enum":["generate_image","edit_image","generate_speech","generate_sound","generate_music","generate_video","render_ad_set","create_brand_kit","create_file","create_page","create_package"]},"label":{"type":"string","minLength":1,"maxLength":120},"artifactIds":{"minItems":1,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"modelId":{"type":"string","minLength":1,"maxLength":200},"promptSha256":{"type":"string","pattern":"^[a-f0-9]{64}$"},"directServiceCallId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["tool","label","artifactIds"],"additionalProperties":false}},"webSearches":{"type":"array","items":{"type":"object","properties":{"query":{"type":"string","minLength":1,"maxLength":500},"sources":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":400},"url":{"type":"string","maxLength":2000},"title":{"type":"string","minLength":1,"maxLength":300},"domain":{"type":"string","minLength":1,"maxLength":253}},"required":["id","url"],"additionalProperties":false}}},"required":["sources"],"additionalProperties":false}},"actionFailures":{"type":"array","items":{"type":"object","properties":{"toolCallId":{"type":"string","minLength":1,"maxLength":256},"operationId":{"type":"string","pattern":"^[a-z0-9]+(?:[._-][a-z0-9]+)*\\.v[1-9][0-9]*$"},"toolName":{"type":"string","pattern":"^[a-z0-9]+(?:_[a-z0-9]+)*$"},"outcome":{"type":"string","enum":["refused","failed"]},"message":{"type":"string","minLength":1,"maxLength":700}},"required":["toolCallId","toolName","outcome","message"],"additionalProperties":false}},"siteChecks":{"type":"array","items":{"type":"object","properties":{"tool":{"type":"string","enum":["inspect_site","test_site_interaction","read_site_interaction"]},"label":{"type":"string","minLength":1,"maxLength":200},"failed":{"type":"boolean","const":true}},"required":["tool","label"],"additionalProperties":false}}},"required":["queries"],"additionalProperties":false}},"required":["type","data"],"additionalProperties":false},"AlphaPartsItem":{"anyOf":[{"$ref":"#/components/schemas/AlphaPartsItemVariant"},{"type":"object","properties":{"type":{"type":"string","const":"data-action"},"data":{"type":"object","properties":{"proposal":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"operationId":{"type":"string","pattern":"^[a-z0-9]+(?:[._-][a-z0-9]+)*\\.v[1-9][0-9]*$"},"toolName":{"type":"string","pattern":"^[a-z0-9]+(?:_[a-z0-9]+)*$"},"label":{"type":"string","minLength":1,"maxLength":120},"description":{"type":"string","minLength":1,"maxLength":1000},"completionMode":{"type":"string","enum":["immediate","durable"]},"input":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/JsonValue"}},"preview":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/JsonValue"}},"confirmation":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":120},"body":{"type":"string","minLength":1,"maxLength":1000},"buttonLabel":{"type":"string","minLength":1,"maxLength":80}},"required":["title","body","buttonLabel"],"additionalProperties":false}},"required":["id","operationId","toolName","label","description","completionMode","input","preview","confirmation"],"additionalProperties":false},"receipt":{"$ref":"#/components/schemas/AlphaProposedActionsConfirmResponse"}},"required":["proposal"],"additionalProperties":false}},"required":["type","data"],"additionalProperties":false},{"$ref":"#/components/schemas/AlphaPartsItemVariant2"},{"type":"object","properties":{"type":{"type":"string","const":"data-dashboard-view"},"data":{"type":"object","properties":{"view":{"type":"string","maxLength":80,"pattern":"^[a-z][a-z0-9]*(?:_[a-z0-9]+)*$"},"viewVersion":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"title":{"type":"string","minLength":1,"maxLength":160},"scope":{"type":"object","properties":{"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"campaignName":{"type":"string","minLength":1,"maxLength":200}},"additionalProperties":false},"filters":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string","minLength":1,"maxLength":240},{"type":"number"},{"type":"boolean"},{"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":240}}]}},"filterLabels":{"maxItems":12,"type":"array","items":{"type":"object","properties":{"key":{"type":"string","maxLength":80,"pattern":"^[a-z][a-z0-9]*(?:_[a-z0-9]+)*$"},"label":{"type":"string","minLength":1,"maxLength":80},"value":{"type":"string","minLength":1,"maxLength":240}},"required":["key","label","value"],"additionalProperties":false}},"snapshot":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/JsonValue"}},"sourceRunIds":{"maxItems":24,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"generatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"canonicalHref":{"type":"string","maxLength":2000,"pattern":"^\\/app\\/campaigns\\/"}},"required":["view","viewVersion","title","scope","filters","filterLabels","snapshot","sourceRunIds","generatedAt","canonicalHref"],"additionalProperties":false}},"required":["type","data"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"data-suggestion"},"data":{"type":"object","properties":{"suggestions":{"minItems":1,"maxItems":4,"type":"array","items":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"question"},"text":{"type":"string","minLength":1,"maxLength":200}},"required":["kind","text"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"action"},"actionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","actionId"],"additionalProperties":false}]}}},"required":["suggestions"],"additionalProperties":false}},"required":["type","data"],"additionalProperties":false}]},"AlphaPartsItemVariant":{"type":"object","properties":{"type":{"type":"string","const":"data-agent-progress"},"data":{"type":"object","properties":{"observedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"assignments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"role":{"type":"string","enum":["lead","evidence","creation","reviewer"]},"objective":{"type":"string"},"status":{"type":"string","enum":["reserved","running","succeeded","failed"]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"startedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"notes":{"type":"array","items":{"type":"string"}}},"required":["id","role","objective","status","createdAt","startedAt","completedAt"],"additionalProperties":false}}},"required":["assignments"],"additionalProperties":false}},"required":["type","data"],"additionalProperties":false},"AlphaPartsItemVariant2":{"type":"object","properties":{"type":{"type":"string","const":"data-artifact"},"data":{"$ref":"#/components/schemas/AlphaData2"}},"required":["type","data"],"additionalProperties":false},"AlphaData2":{"type":"object","properties":{"adSuite":{"$ref":"#/components/schemas/AlphaAdSuite"},"artifactPackage":{"$ref":"#/components/schemas/AlphaArtifactPackage"},"calculation":{"type":"object","properties":{"status":{"type":"string","enum":["recalculated","unavailable"]},"engine":{"type":"string","const":"libreoffice"},"formulaCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"findings":{"type":"array","items":{"type":"object","properties":{"sheet":{"type":"string"},"cell":{"type":"string"},"error":{"type":"string"}},"required":["sheet","cell","error"],"additionalProperties":false}}},"required":["status","engine","formulaCount","findings"],"additionalProperties":false},"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"kind":{"type":"string","enum":["markdown","slides","image","audio","video","brand_kit","presentation","spreadsheet","word","pdf","csv","page"]},"title":{"type":"string","minLength":1,"maxLength":160},"mediaType":{"type":"string","enum":["text/markdown","application/vnd.point11.slides+json","image/png","image/jpeg","image/webp","audio/mpeg","audio/wav","video/mp4","video/webm","application/vnd.point11.brand-kit+json","application/vnd.openxmlformats-officedocument.presentationml.presentation","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","application/vnd.openxmlformats-officedocument.wordprocessingml.document","application/pdf","text/csv","text/html","application/vnd.point11.website+json"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":1073741824},"status":{"type":"string","enum":["ready","pending"]},"revisesArtifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"brandName":{"type":"string","minLength":1,"maxLength":120},"slideCount":{"type":"integer","exclusiveMinimum":0,"maximum":60},"previewArtifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"previewFailure":{"type":"string","enum":["render_failed","invalid_preview","upload_failed"]},"websitePreview":{"$ref":"#/components/schemas/AlphaWebsitePreview"},"websitePreviewFailure":{"type":"string","enum":["capture_failed","upload_failed"]},"evidence":{"maxItems":512,"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["query_run","verified_metric","web_source","attachment","artifact"]},"id":{"type":"string","minLength":1,"maxLength":400},"observedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["kind","id","observedAt"],"additionalProperties":false}},"purpose":{"type":"string","enum":["deliverable","working"]}},"required":["artifactId","kind","title","mediaType"],"additionalProperties":false},"AlphaAdSuite":{"type":"object","properties":{"suiteId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"href":{"type":"string","pattern":"^\\/app\\/alpha\\/ads.*"},"variantFailures":{"type":"array","items":{"type":"object","properties":{"variantId":{"type":"string","minLength":1,"maxLength":80},"message":{"type":"string","minLength":1,"maxLength":4000}},"required":["variantId","message"],"additionalProperties":false}},"findings":{"description":"Measured evidence from this render; absent when there is none.","maxItems":256,"type":"array","items":{"$ref":"#/components/schemas/AlphaFindingsItem"}},"findingsOmitted":{"description":"How many further findings this render measured past the ones listed.","type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"assets":{"type":"array","items":{"type":"object","properties":{"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"variantId":{"type":"string"},"href":{"type":"string","pattern":"^\\/app\\/api\\/alpha\\/ads\\/.*"}},"required":["artifactId","variantId","href"],"additionalProperties":false}}},"required":["suiteId","revisionId","revision","href","assets"],"additionalProperties":false},"AlphaArtifactPackage":{"type":"object","properties":{"version":{"type":"number","const":1},"creativeRound":{"type":"object","properties":{"projectId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"roundId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"variantArtifactIds":{"minItems":1,"maxItems":5,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},"required":["projectId","roundId","variantArtifactIds"],"additionalProperties":false},"creativeDeliverables":{"maxItems":60,"type":"array","items":{"$ref":"#/components/schemas/AlphaDeliverablesItem"}},"brief":{"type":"string","minLength":1,"maxLength":8000},"evidenceScope":{"type":"string","minLength":1,"maxLength":8000},"members":{"minItems":1,"type":"array","items":{"type":"object","properties":{"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"role":{"type":"string","minLength":1,"maxLength":160},"dependsOn":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"changeNotes":{"type":"string","maxLength":2000}},"required":["artifactId","role","dependsOn","changeNotes"],"additionalProperties":false}}},"required":["version","brief","evidenceScope","members"],"additionalProperties":false},"AlphaWebsitePreview":{"type":"object","properties":{"desktopArtifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"mobileArtifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"thumbnailArtifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"errorCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"consoleErrorCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"a11yViolationCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"a11yCriticalCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"states":{"type":"array","items":{"type":"object","properties":{"stateId":{"type":"string"},"path":{"type":"string"},"purpose":{"type":"string"},"device":{"type":"string","enum":["desktop","mobile"]},"finalPath":{"anyOf":[{"type":"string"},{"type":"null"}]},"screenshotArtifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"actions":{"type":"array","items":{"type":"object","properties":{"index":{"type":"integer","minimum":0,"maximum":9007199254740991},"kind":{"type":"string"},"status":{"type":"string","enum":["completed","failed","skipped"]}},"required":["index","kind","status"],"additionalProperties":false}},"checks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["passed","failed","unavailable"]},"actual":{"anyOf":[{"type":"string"},{"type":"boolean"},{"type":"null"}]}},"required":["id","status","actual"],"additionalProperties":false}},"errorCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"consoleErrorCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"a11yViolationCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"failures":{"type":"array","items":{"type":"string"}}},"required":["stateId","path","purpose","device","finalPath","actions","checks","errorCount","consoleErrorCount","a11yViolationCount","failures"],"additionalProperties":false}},"findings":{"type":"object","properties":{"errors":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"message":{"type":"string","maxLength":500},"seenOn":{"maxItems":8,"type":"array","items":{"type":"string","maxLength":220}}},"required":["message","seenOn"],"additionalProperties":false}},"consoleErrors":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"text":{"type":"string","maxLength":500},"seenOn":{"maxItems":8,"type":"array","items":{"type":"string","maxLength":220}}},"required":["text","seenOn"],"additionalProperties":false}},"a11yViolations":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","maxLength":200},"impact":{"anyOf":[{"type":"string","enum":["minor","moderate","serious","critical"]},{"type":"null"}]},"help":{"type":"string","maxLength":500},"targets":{"maxItems":3,"type":"array","items":{"type":"string","maxLength":500}},"seenOn":{"maxItems":8,"type":"array","items":{"type":"string","maxLength":220}}},"required":["id","impact","help","targets","seenOn"],"additionalProperties":false}},"brokenLinks":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"file":{"type":"string","maxLength":1024},"reference":{"type":"string","maxLength":500}},"required":["file","reference"],"additionalProperties":false}},"brokenLinkCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"performance":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"seenOn":{"type":"string","maxLength":220},"lcpMs":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"cls":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"fcpMs":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"ttfbMs":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"tbtMs":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"transferBytes":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"imageBytes":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"requestCount":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]}},"required":["seenOn","lcpMs","cls","fcpMs","ttfbMs","tbtMs","transferBytes","imageBytes","requestCount"],"additionalProperties":false}},"seo":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","enum":["missing_title","missing_description","missing_lang","missing_viewport","image_missing_alt"]},"detail":{"type":"string","maxLength":500},"seenOn":{"maxItems":8,"type":"array","items":{"type":"string","maxLength":220}}},"required":["id","detail","seenOn"],"additionalProperties":false}}},"required":["errors","consoleErrors","a11yViolations","brokenLinks","brokenLinkCount"],"additionalProperties":false}},"required":["errorCount","consoleErrorCount","a11yViolationCount","a11yCriticalCount"],"additionalProperties":false},"AlphaSharing":{"type":"object","properties":{"access":{"type":"string","enum":["author","participant","reader"]},"ownerName":{"type":"string","minLength":1,"maxLength":320},"project":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":80},"visibility":{"type":"string","enum":["private","organization"]},"teammateOwned":{"description":"Another member owns the project, and so wrote its instructions","type":"boolean","const":true}},"required":["id","name","visibility"],"additionalProperties":false},{"type":"null"}]},"organizationWide":{"description":"Every member reads it: its project is shared with the organization, or it started where every member works (an Advisor action's chat, a Slack channel thread's)","type":"boolean","const":true},"startedByApiKey":{"type":"boolean","const":true},"connectorsNeedOptIn":{"description":"Someone other than this reader asked a question, sent a file or owns the project here, so the reader's connected tools join a question of theirs only when it sets useConnectors","type":"boolean","const":true},"people":{"description":"The members the owner shared this conversation with by name","maxItems":25,"type":"array","items":{"type":"object","properties":{"userId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":320}},"required":["userId","name"],"additionalProperties":false}}},"required":["access","ownerName","project"],"additionalProperties":false},"AlphaPlan":{"anyOf":[{"type":"object","properties":{"conversationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"plan":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":120},"goal":{"type":"string","minLength":1,"maxLength":200},"thinking":{"type":"string","minLength":1,"maxLength":2000},"steps":{"maxItems":40,"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":80},"title":{"type":"string","minLength":1,"maxLength":160},"why":{"type":"string","minLength":1,"maxLength":400},"performer":{"type":"string","enum":["alpha","person"]},"minutes":{"type":"integer","exclusiveMinimum":0,"maximum":100000},"status":{"type":"string","enum":["todo","doing","done","needs_you","skipped"]},"note":{"anyOf":[{"type":"string","minLength":1,"maxLength":400},{"type":"null"}]}},"required":["key","title","why","performer","minutes","status","note"],"additionalProperties":false}}},"required":["title","goal","thinking","steps"],"additionalProperties":false}},"required":["conversationId","revision","plan"],"additionalProperties":false},{"type":"null"}],"description":"The plan Alpha keeps in this conversation, as last saved: its steps, who does each, and where each stands; null before Alpha writes one"},"AlphaPlanVersions":{"type":"array","items":{"$ref":"#/components/schemas/AlphaItem2"},"description":"The plan's history, oldest first: one version per answer that wrote it (its last revision, with that answer's turn and when it was saved); the newest is `plan`"},"AlphaItem2":{"type":"object","properties":{"conversationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"plan":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":120},"goal":{"type":"string","minLength":1,"maxLength":200},"thinking":{"type":"string","minLength":1,"maxLength":2000},"steps":{"maxItems":40,"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":80},"title":{"type":"string","minLength":1,"maxLength":160},"why":{"type":"string","minLength":1,"maxLength":400},"performer":{"type":"string","enum":["alpha","person"]},"minutes":{"type":"integer","exclusiveMinimum":0,"maximum":100000},"status":{"type":"string","enum":["todo","doing","done","needs_you","skipped"]},"note":{"anyOf":[{"type":"string","minLength":1,"maxLength":400},{"type":"null"}]}},"required":["key","title","why","performer","minutes","status","note"],"additionalProperties":false}}},"required":["title","goal","thinking","steps"],"additionalProperties":false},"turnId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["conversationId","revision","plan","turnId","createdAt"],"additionalProperties":false},"AlphaConversation":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"title":{"type":"string","minLength":1,"maxLength":120},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"messages":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"metadata":{"$ref":"#/components/schemas/AlphaItemMetadata"},"role":{"type":"string","const":"assistant"},"parts":{"type":"array","prefixItems":[{"type":"object","properties":{"type":{"type":"string","const":"text"},"text":{"type":"string","minLength":1,"maxLength":65536}},"required":["type","text"],"additionalProperties":false},{"$ref":"#/components/schemas/AlphaItemParts"}],"items":{"$ref":"#/components/schemas/AlphaPartsItem"}}},"required":["id","metadata","role","parts"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"metadata":{"$ref":"#/components/schemas/AlphaItemMetadata"},"role":{"type":"string","const":"assistant"},"parts":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/AlphaPartsItemVariant2"},{"$ref":"#/components/schemas/AlphaPartsItemVariant"},{"$ref":"#/components/schemas/AlphaItemParts"},{"type":"object","properties":{"type":{"type":"string","const":"data-turn-state"},"data":{"type":"object","properties":{"status":{"type":"string","enum":["running","failed","cancelled"]},"failureCode":{"type":"string","minLength":1,"maxLength":160},"message":{"type":"string","minLength":1,"maxLength":1000},"retryable":{"type":"boolean"}},"required":["status","retryable"],"additionalProperties":false}},"required":["type","data"],"additionalProperties":false}]}}},"required":["id","metadata","role","parts"],"additionalProperties":false},{"$ref":"#/components/schemas/AlphaMessagesItem"}]}},"nextBeforeMessageIndex":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]}},"required":["id","title","createdAt","updatedAt","messages","nextBeforeMessageIndex"],"additionalProperties":false},"AlphaItemMetadata":{"type":"object","properties":{"brand":{"type":"object","properties":{"profileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"unbranded":{"type":"boolean"}},"additionalProperties":false},"regenerateTurnId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"responseVersion":{"$ref":"#/components/schemas/AlphaResponseVersion"},"threadId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"turnId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"attachments":{"maxItems":5,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["text/plain","text/csv","application/json","text/markdown","text/html","application/vnd.openxmlformats-officedocument.wordprocessingml.document","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","application/vnd.openxmlformats-officedocument.presentationml.presentation","image/png","image/jpeg","image/webp","application/pdf"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":10000000}},"required":["id","filename","mediaType","byteLength"],"additionalProperties":false}},"effort":{"type":"string","enum":["low","xhigh","max"]},"model":{"type":"string","minLength":3,"maxLength":120,"pattern":"^[a-z0-9][a-z0-9-]*\\/[A-Za-z0-9][A-Za-z0-9._:-]*$"},"analysisDurationMs":{"type":"integer","minimum":0,"maximum":9007199254740991},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"feedback":{"type":"object","properties":{"rating":{"type":"string","enum":["up","down"]},"comment":{"anyOf":[{"type":"string","minLength":1,"maxLength":2000},{"type":"null"}]},"reasons":{"type":"array","items":{"type":"string","enum":["on_brief","accurate","looks_great","on_brand","ready_to_use","off_brief","wrong_numbers","layout_problems","off_brand","hard_to_edit","missing_content","text_errors"]}},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["rating","comment","updatedAt"],"additionalProperties":false},"intent":{"type":"string","enum":["presentation","spreadsheet","document","pdf","ads","page","image"]},"adBrief":{"type":"object","properties":{"type":{"type":"string","enum":["static","search","responsive_display","landing_page"]},"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lossReasonId":{"type":"string","minLength":1,"maxLength":1000},"campaignName":{"type":"string","minLength":1,"maxLength":500},"lossReason":{"type":"string","minLength":1,"maxLength":2000}},"additionalProperties":false},"viewing":{"type":"object","properties":{"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"unit":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["slide","page"]},"index":{"type":"integer","minimum":1,"maximum":9999}},"required":["type","index"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["range","element","state"]},"text":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[^\\u0000-\\u001f\\u007f]+$"}},"required":["type","text"],"additionalProperties":false}]}},"required":["artifactId"],"additionalProperties":false},"useConnectors":{"type":"boolean","const":true},"connectorContinuation":{"type":"boolean","const":true},"asker":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":320},"mine":{"type":"boolean"}},"required":["name","mine"],"additionalProperties":false},"brief":{"type":"object","properties":{"deliverable":{"type":"string","enum":["presentation","page","ads"]},"goal":{"type":"string","minLength":1,"maxLength":300},"audience":{"type":"string","minLength":1,"maxLength":200},"outline":{"minItems":1,"maxItems":12,"type":"array","items":{"type":"string","minLength":1,"maxLength":150}},"sources":{"maxItems":6,"type":"array","items":{"type":"string","minLength":1,"maxLength":150}},"brand":{"type":"string","minLength":1,"maxLength":150},"estimate":{"type":"object","properties":{"sampleSize":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"medianDurationMs":{"type":"integer","minimum":0,"maximum":9007199254740991},"medianCredits":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["sampleSize","medianDurationMs","medianCredits"],"additionalProperties":false}},"required":["deliverable","goal","audience","outline","sources","brand"],"additionalProperties":false},"connectorCard":{"$ref":"#/components/schemas/AlphaConnectorCard"}},"required":["threadId","turnId"],"additionalProperties":false},"AlphaItemParts":{"type":"object","properties":{"type":{"type":"string","const":"data-evidence"},"data":{"type":"object","properties":{"queries":{"type":"array","items":{"type":"object","properties":{"purpose":{"type":"string","minLength":1,"maxLength":500},"sql":{"type":"string","minLength":1,"maxLength":30000},"rowCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"truncated":{"type":"boolean"},"columns":{"maxItems":200,"type":"array","items":{"type":"string"}},"durationMs":{"type":"integer","minimum":0,"maximum":9007199254740991},"resultBytes":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["purpose","rowCount","truncated","columns"],"additionalProperties":false}},"connectorCalls":{"type":"array","items":{"type":"object","properties":{"connector":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,127}\\/[a-zA-Z0-9][a-zA-Z0-9._/-]{0,255}$"},"tool":{"type":"string","maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:/-]*$"},"status":{"type":"string","enum":["ok","error"]},"reason":{"type":"string","enum":["member_always_allow","org_allow","approved_once","admin_approved_once"]}},"required":["connector","tool","status"],"additionalProperties":false}},"createCalls":{"type":"array","items":{"type":"object","properties":{"tool":{"type":"string","enum":["generate_image","edit_image","generate_speech","generate_sound","generate_music","generate_video","render_ad_set","create_brand_kit","create_file","edit_file","create_page","create_package"]},"label":{"type":"string","minLength":1,"maxLength":120},"artifactIds":{"minItems":1,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"modelId":{"type":"string","minLength":1,"maxLength":200},"promptSha256":{"type":"string","pattern":"^[a-f0-9]{64}$"},"directServiceCallId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["tool","label","artifactIds"],"additionalProperties":false}},"webSearches":{"type":"array","items":{"type":"object","properties":{"query":{"type":"string","minLength":1,"maxLength":500},"sources":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":400},"url":{"type":"string","maxLength":2000},"title":{"type":"string","minLength":1,"maxLength":300},"domain":{"type":"string","minLength":1,"maxLength":253}},"required":["id","url"],"additionalProperties":false}}},"required":["sources"],"additionalProperties":false}},"actionFailures":{"type":"array","items":{"type":"object","properties":{"toolCallId":{"type":"string","minLength":1,"maxLength":256},"operationId":{"type":"string","pattern":"^[a-z0-9]+(?:[._-][a-z0-9]+)*\\.v[1-9][0-9]*$"},"toolName":{"type":"string","pattern":"^[a-z0-9]+(?:_[a-z0-9]+)*$"},"outcome":{"type":"string","enum":["refused","failed"]},"message":{"type":"string","minLength":1,"maxLength":700}},"required":["toolCallId","toolName","outcome","message"],"additionalProperties":false}},"siteChecks":{"type":"array","items":{"type":"object","properties":{"tool":{"type":"string","enum":["inspect_site","test_site_interaction","read_site_interaction"]},"label":{"type":"string","minLength":1,"maxLength":200},"failed":{"type":"boolean","const":true}},"required":["tool","label"],"additionalProperties":false}}},"required":["queries"],"additionalProperties":false}},"required":["type","data"],"additionalProperties":false},"AlphaMessagesItem":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"metadata":{"$ref":"#/components/schemas/AlphaItemMetadata"},"role":{"type":"string","const":"user"},"parts":{"type":"array","prefixItems":[{"type":"object","properties":{"type":{"type":"string","const":"text"},"text":{"type":"string","minLength":1,"maxLength":65536}},"required":["type","text"],"additionalProperties":false}],"items":{"type":"object","properties":{"type":{"type":"string","const":"file"},"mediaType":{"type":"string","enum":["text/plain","text/csv","application/json","text/markdown","text/html","application/vnd.openxmlformats-officedocument.wordprocessingml.document","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","application/vnd.openxmlformats-officedocument.presentationml.presentation","image/png","image/jpeg","image/webp","application/pdf"]},"filename":{"type":"string","minLength":1,"maxLength":255},"url":{"type":"string","pattern":"^\\/app\\/api\\/ask-data\\/attachments\\/[0-9a-f-]{36}$","description":"The dashboard's link to the file, for a signed-in browser only; API callers read it with alpha.attachments.download by the attachment id in metadata.attachments"}},"required":["type","mediaType","url"],"additionalProperties":false}}},"required":["id","metadata","role","parts"],"additionalProperties":false},"AlphaPlan2":{"anyOf":[{"$ref":"#/components/schemas/AlphaItem2"},{"type":"null"}],"description":"The plan Alpha keeps in this conversation: its newest version with its steps, who does each, and where each stands, the answer that wrote it, and when; null before Alpha writes one"},"AlphaPlanTrack":{"anyOf":[{"type":"object","properties":{"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"thinking":{"anyOf":[{"type":"string","minLength":1,"maxLength":2000},{"type":"null"}]},"rows":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":80},"title":{"type":"string","minLength":1,"maxLength":160},"performer":{"type":"string","enum":["alpha","person"]},"status":{"type":"string","enum":["todo","doing","done","needs_you","skipped","removed"]},"note":{"anyOf":[{"type":"string","minLength":1,"maxLength":400},{"type":"null"}]},"added":{"type":"boolean"}},"required":["key","title","performer","status","note","added"],"additionalProperties":false}},"log":{"$ref":"#/components/schemas/AlphaLog"}},"required":["revision","thinking","rows","log"],"additionalProperties":false},{"type":"null"}],"description":"`plan` as a running record: the steps of the first version that listed any, in its order, each where `plan` says it stands, and a log of what each version changed; null with `plan`"},"AlphaLog":{"type":"array","items":{"type":"object","properties":{"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"changes":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"created"},"steps":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["kind","steps"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"added"},"title":{"type":"string","minLength":1,"maxLength":160}},"required":["kind","title"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"removed"},"title":{"type":"string","minLength":1,"maxLength":160}},"required":["kind","title"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"renamed"},"from":{"type":"string","minLength":1,"maxLength":160},"to":{"type":"string","minLength":1,"maxLength":160}},"required":["kind","from","to"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"status"},"title":{"type":"string","minLength":1,"maxLength":160},"from":{"type":"string","enum":["todo","doing","done","needs_you","skipped"]},"to":{"type":"string","enum":["todo","doing","done","needs_you","skipped"]},"note":{"anyOf":[{"type":"string","minLength":1,"maxLength":400},{"type":"null"}]}},"required":["kind","title","from","to"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"note"},"title":{"type":"string","minLength":1,"maxLength":160},"note":{"anyOf":[{"type":"string","minLength":1,"maxLength":400},{"type":"null"}]}},"required":["kind","title","note"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"updated"}},"required":["kind"],"additionalProperties":false}]}}},"required":["revision","at","changes"],"additionalProperties":false}},"AlphaPlanVersions2":{"type":"array","items":{"$ref":"#/components/schemas/AlphaItem3"},"description":"The plan's history, oldest first: one entry per answer that wrote it, with its title and how far it had come, never its body; the newest is `plan`, and alpha.conversation-plans.get reads another by its revision"},"AlphaItem3":{"type":"object","properties":{"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"turnId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"title":{"type":"string","minLength":1,"maxLength":120},"progress":{"type":"object","properties":{"done":{"type":"integer","minimum":0,"maximum":9007199254740991},"total":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["done","total"],"additionalProperties":false}},"required":["revision","turnId","createdAt","title","progress"],"additionalProperties":false},"AlphaConversationMessagesItem":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"metadata":{"$ref":"#/components/schemas/AlphaItemMetadata"},"role":{"type":"string","const":"assistant"},"parts":{"type":"array","prefixItems":[{"type":"object","properties":{"type":{"type":"string","const":"text"},"text":{"type":"string","minLength":1,"maxLength":65536}},"required":["type","text"],"additionalProperties":false},{"$ref":"#/components/schemas/AlphaParts2"}],"items":{"$ref":"#/components/schemas/AlphaPartsItem"}}},"required":["id","metadata","role","parts"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"metadata":{"$ref":"#/components/schemas/AlphaItemMetadata"},"role":{"type":"string","const":"assistant"},"parts":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/AlphaPartsItemVariant2"},{"$ref":"#/components/schemas/AlphaPartsItemVariant"},{"$ref":"#/components/schemas/AlphaParts2"},{"type":"object","properties":{"type":{"type":"string","const":"data-turn-state"},"data":{"type":"object","properties":{"status":{"type":"string","enum":["running","failed","cancelled"]},"failureCode":{"type":"string","minLength":1,"maxLength":160},"message":{"type":"string","minLength":1,"maxLength":1000},"retryable":{"type":"boolean"}},"required":["status","retryable"],"additionalProperties":false}},"required":["type","data"],"additionalProperties":false}]}}},"required":["id","metadata","role","parts"],"additionalProperties":false},{"$ref":"#/components/schemas/AlphaMessagesItem"}]},"AlphaParts2":{"type":"object","properties":{"type":{"type":"string","const":"data-evidence"},"data":{"type":"object","properties":{"queries":{"type":"array","items":{"type":"object","properties":{"purpose":{"type":"string","minLength":1,"maxLength":500},"sql":{"type":"string","minLength":1,"maxLength":30000},"rowCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"truncated":{"type":"boolean"},"columns":{"maxItems":200,"type":"array","items":{"type":"string"}},"durationMs":{"type":"integer","minimum":0,"maximum":9007199254740991},"resultBytes":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["purpose","rowCount","truncated","columns"],"additionalProperties":false}},"connectorCalls":{"type":"array","items":{"type":"object","properties":{"connector":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{0,127}\\/[a-zA-Z0-9][a-zA-Z0-9._/-]{0,255}$"},"tool":{"type":"string","maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_.:/-]*$"},"status":{"type":"string","enum":["ok","error"]},"reason":{"type":"string","enum":["member_always_allow","org_allow","approved_once","admin_approved_once"]}},"required":["connector","tool","status"],"additionalProperties":false}},"createCalls":{"type":"array","items":{"type":"object","properties":{"tool":{"type":"string","enum":["generate_image","edit_image","edit_media","generate_speech","generate_sound","generate_music","generate_video","render_ad_set","create_brand_kit","create_file","edit_file","create_page","create_package"]},"label":{"type":"string","minLength":1,"maxLength":120},"artifactIds":{"minItems":1,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"modelId":{"type":"string","minLength":1,"maxLength":200},"promptSha256":{"type":"string","pattern":"^[a-f0-9]{64}$"},"directServiceCallId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["tool","label","artifactIds"],"additionalProperties":false}},"webSearches":{"type":"array","items":{"type":"object","properties":{"query":{"type":"string","minLength":1,"maxLength":500},"sources":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":400},"url":{"type":"string","maxLength":2000},"title":{"type":"string","minLength":1,"maxLength":300},"domain":{"type":"string","minLength":1,"maxLength":253}},"required":["id","url"],"additionalProperties":false}}},"required":["sources"],"additionalProperties":false}},"actionFailures":{"type":"array","items":{"type":"object","properties":{"toolCallId":{"type":"string","minLength":1,"maxLength":256},"operationId":{"type":"string","pattern":"^[a-z0-9]+(?:[._-][a-z0-9]+)*\\.v[1-9][0-9]*$"},"toolName":{"type":"string","pattern":"^[a-z0-9]+(?:_[a-z0-9]+)*$"},"outcome":{"type":"string","enum":["refused","failed"]},"message":{"type":"string","minLength":1,"maxLength":700}},"required":["toolCallId","toolName","outcome","message"],"additionalProperties":false}},"siteChecks":{"type":"array","items":{"type":"object","properties":{"tool":{"type":"string","enum":["inspect_site","test_site_interaction","read_site_interaction"]},"label":{"type":"string","minLength":1,"maxLength":200},"failed":{"type":"boolean","const":true}},"required":["tool","label"],"additionalProperties":false}}},"required":["queries"],"additionalProperties":false}},"required":["type","data"],"additionalProperties":false},"AlphaReceipt":{"type":"object","properties":{"kind":{"type":"string","enum":["immediate","durable_run"]},"microsoftFile":{"type":"object","properties":{"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"driveId":{"type":"string","minLength":1,"maxLength":256},"itemId":{"type":"string","minLength":1,"maxLength":256},"contentTag":{"type":"string","minLength":1,"maxLength":1024},"sha256":{"type":"string","pattern":"^[0-9a-f]{64}$"}},"required":["artifactId","driveId","itemId","contentTag","sha256"],"additionalProperties":false},"referenceId":{"type":"string","minLength":1,"maxLength":200},"label":{"type":"string","minLength":1,"maxLength":120},"state":{"type":"string","minLength":1,"maxLength":120},"href":{"type":"string","maxLength":2000}},"required":["kind","referenceId","label","state"],"additionalProperties":false},"AlphaPublication":{"type":"object","properties":{"publicationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"pageId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"publishedArtifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"url":{"type":"string","format":"uri"},"visibility":{"type":"string","enum":["link","password"]},"discoverable":{"type":"boolean"},"publishedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"views":{"type":"integer","minimum":0,"maximum":9007199254740991},"suspended":{"description":"Point11 took the link down: viewers find nothing, and it can only be ended","type":"boolean"}},"required":["pageId","publishedArtifactId","url","visibility","discoverable","publishedAt","views"],"additionalProperties":false},"ResearchQuestionsItem":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128},"title":{"type":"string","maxLength":500},"prompt":{"type":"string","maxLength":10000},"flow":{"$ref":"#/components/schemas/ResearchFlow"},"attachment":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm","audio/mpeg","audio/wav"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":104857600}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false},"stimulusItemId":{"type":"string","minLength":1,"maxLength":128},"blind":{"type":"boolean","const":true},"shape":{"type":"string","const":"open_ended"}},"required":["id","title","prompt","shape"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128},"title":{"type":"string","maxLength":500},"prompt":{"type":"string","maxLength":10000},"flow":{"$ref":"#/components/schemas/ResearchFlow"},"attachment":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm","audio/mpeg","audio/wav"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":104857600}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false},"stimulusItemId":{"type":"string","minLength":1,"maxLength":128},"blind":{"type":"boolean","const":true},"shape":{"type":"string","enum":["closed_ended","multi_select","rank","matrix","scale"]},"options":{"maxItems":100,"type":"array","items":{"type":"string","maxLength":500}},"maxSelections":{"type":"integer","minimum":1,"maximum":100},"unaided":{"type":"boolean","const":true}},"required":["id","title","prompt","shape","options"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128},"title":{"type":"string","maxLength":500},"prompt":{"type":"string","maxLength":10000},"flow":{"$ref":"#/components/schemas/ResearchFlow"},"attachment":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm","audio/mpeg","audio/wav"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":104857600}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false},"stimulusItemId":{"type":"string","minLength":1,"maxLength":128},"blind":{"type":"boolean","const":true},"shape":{"type":"string","const":"computer_task"},"targets":{"$ref":"#/components/schemas/ResearchTargets"},"successCriteria":{"type":"string","maxLength":10000}},"required":["id","title","prompt","shape","targets","successCriteria"],"additionalProperties":false}]},"ResearchFlow":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"goto"},"target":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"next"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"question"},"questionId":{"type":"string","minLength":1,"maxLength":128}},"required":["kind","questionId"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"end"}},"required":["kind"],"additionalProperties":false}]}},"required":["kind","target"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"branch"},"rules":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128},"condition":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"option"},"option":{"type":"string","maxLength":500}},"required":["kind","option"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"rating"},"operator":{"type":"string","enum":["eq","lt","lte","gt","gte"]},"value":{"type":"number"}},"required":["kind","operator","value"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"meaning"},"criterion":{"type":"string","maxLength":10000}},"required":["kind","criterion"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"task"},"success":{"type":"boolean"}},"required":["kind","success"],"additionalProperties":false}]},"target":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"next"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"question"},"questionId":{"type":"string","minLength":1,"maxLength":128}},"required":["kind","questionId"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"end"}},"required":["kind"],"additionalProperties":false}]}},"required":["id","condition","target"],"additionalProperties":false}},"otherwise":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"next"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"question"},"questionId":{"type":"string","minLength":1,"maxLength":128}},"required":["kind","questionId"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"end"}},"required":["kind"],"additionalProperties":false}]}},"required":["kind","rules","otherwise"],"additionalProperties":false}]},"ResearchTargets":{"maxItems":3,"type":"array","items":{"anyOf":[{"type":"object","properties":{"platform":{"type":"string","const":"website"},"startUrl":{"type":"string","maxLength":2048},"devices":{"maxItems":3,"type":"array","items":{"type":"string","enum":["desktop","ios","android"]}}},"required":["platform","startUrl","devices"],"additionalProperties":false},{"type":"object","properties":{"platform":{"type":"string","enum":["ios","android"]},"startUrl":{"type":"string","maxLength":2048},"selection":{"type":"object","properties":{"connectionId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"string","const":""}]},"accountId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"string","const":""}]},"buildId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"string","const":""}]},"deviceKey":{"type":"string","maxLength":240}},"required":["connectionId","accountId","buildId","deviceKey"],"additionalProperties":false}},"required":["platform","startUrl"],"additionalProperties":false}]}},"ResearchStimulus":{"oneOf":[{"type":"object","properties":{"version":{"type":"string","const":"research-stimulus.v1"},"kind":{"type":"string","const":"brand"},"title":{"type":"string","minLength":1,"maxLength":500},"brand":{"type":"string","minLength":1,"maxLength":200},"category":{"type":"string","minLength":1,"maxLength":200},"competitors":{"maxItems":5,"type":"array","items":{"type":"string","minLength":1,"maxLength":200}},"startUrl":{"type":"string","maxLength":2000,"format":"uri"},"shownList":{"type":"array","items":{"type":"string"}}},"required":["version","kind","brand","competitors"],"additionalProperties":false},{"type":"object","properties":{"version":{"type":"string","const":"research-stimulus.v1"},"kind":{"type":"string","const":"copy"},"title":{"type":"string","minLength":1,"maxLength":500},"copies":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:/-]*$"},"label":{"type":"string","minLength":1,"maxLength":200},"body":{"type":"string","minLength":1,"maxLength":10000}},"required":["id","body"],"additionalProperties":false}}},"required":["version","kind","copies"],"additionalProperties":false},{"$ref":"#/components/schemas/ResearchStimulusVariant"},{"type":"object","properties":{"version":{"type":"string","const":"research-stimulus.v1"},"kind":{"type":"string","const":"concept"},"title":{"type":"string","minLength":1,"maxLength":500},"concepts":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:/-]*$"},"title":{"type":"string","minLength":1,"maxLength":500},"description":{"type":"string","minLength":1,"maxLength":10000},"assetRefs":{"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":512}},"prototypeUrl":{"type":"string","maxLength":2000,"format":"uri"},"buyerGoal":{"type":"string","minLength":1,"maxLength":120}},"required":["id","title","description"],"additionalProperties":false}}},"required":["version","kind","concepts"],"additionalProperties":false},{"$ref":"#/components/schemas/ResearchStimulusVariant2"},{"$ref":"#/components/schemas/ResearchStimulusVariant3"},{"type":"object","properties":{"version":{"type":"string","const":"research-stimulus.v1"},"kind":{"type":"string","const":"task"},"title":{"type":"string","minLength":1,"maxLength":500},"instructions":{"type":"string","minLength":1,"maxLength":10000},"destinationUrl":{"type":"string","maxLength":2048,"format":"uri"},"problem":{"type":"string","minLength":1,"maxLength":120},"keyMessage":{"type":"string","minLength":1,"maxLength":200}},"required":["version","kind","title","instructions"],"additionalProperties":false},{"type":"object","properties":{"version":{"type":"string","const":"research-stimulus.v1"},"kind":{"type":"string","const":"custom"},"title":{"type":"string","minLength":1,"maxLength":500},"content":{"type":"string","minLength":1,"maxLength":10000},"assetRefs":{"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":512}},"private":{"type":"boolean","const":true}},"required":["version","kind","content"],"additionalProperties":false},{"$ref":"#/components/schemas/ResearchStimulusVariant4"}],"description":"The study's material. Acceptable use screens a Custom study's content whole, so it is at most 2,000 characters."},"ResearchStimulusVariant":{"type":"object","properties":{"version":{"type":"string","const":"research-stimulus.v1"},"kind":{"type":"string","const":"ads"},"title":{"type":"string","minLength":1,"maxLength":500},"format":{"type":"string","enum":["full_ad","headline","tagline","product_name","email_subject","social_post"]},"placement":{"type":"string","minLength":1,"maxLength":120},"ads":{"minItems":2,"maxItems":5,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:/-]*$"},"headline":{"type":"string","minLength":1,"maxLength":200},"body":{"type":"string","minLength":1,"maxLength":10000},"callToAction":{"type":"string","minLength":1,"maxLength":120},"landingUrl":{"type":"string","maxLength":2000,"format":"uri"},"intendedTakeaway":{"type":"string","minLength":1,"maxLength":200}},"required":["id","headline"],"additionalProperties":false}}},"required":["version","kind","ads"],"additionalProperties":false},"ResearchStimulusVariant2":{"type":"object","properties":{"version":{"type":"string","const":"research-stimulus.v1"},"kind":{"type":"string","const":"offer_set"},"title":{"type":"string","minLength":1,"maxLength":500},"offers":{"minItems":2,"maxItems":50,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:/-]*$"},"title":{"type":"string","minLength":1,"maxLength":500},"description":{"type":"string","minLength":1,"maxLength":10000},"terms":{"type":"string","minLength":1,"maxLength":5000}},"required":["id","title","description"],"additionalProperties":false}},"category":{"type":"string","minLength":1,"maxLength":200},"liveOffer":{"type":"object","properties":{"offerId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:/-]*$"},"url":{"type":"string","maxLength":2000,"format":"uri"}},"required":["offerId","url"],"additionalProperties":false}},"required":["version","kind","offers"],"additionalProperties":false},"ResearchStimulusVariant3":{"type":"object","properties":{"version":{"type":"string","const":"research-stimulus.v1"},"kind":{"type":"string","const":"price_ladder"},"title":{"type":"string","minLength":1,"maxLength":500},"description":{"type":"string","minLength":1,"maxLength":10000},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"billingUnit":{"type":"string","enum":["one_time","per_month","per_year","per_seat_per_month"]},"prices":{"minItems":2,"maxItems":50,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:/-]*$"},"amountMinor":{"type":"integer","minimum":0,"maximum":9007199254740991},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["id","amountMinor"],"additionalProperties":false}},"plannedPriceId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:/-]*$"},"category":{"type":"string","minLength":1,"maxLength":200},"alternatives":{"minItems":1,"maxItems":3,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":60},"amountMinor":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["name","amountMinor"],"additionalProperties":false}},"plans":{"minItems":2,"maxItems":4,"type":"array","items":{"type":"string","minLength":1,"maxLength":60}},"pricingPageUrl":{"type":"string","maxLength":2000,"format":"uri"}},"required":["version","kind","title","currency","prices"],"additionalProperties":false},"ResearchStimulusVariant4":{"type":"object","properties":{"version":{"type":"string","const":"research-stimulus.v1"},"kind":{"type":"string","const":"features"},"title":{"type":"string","minLength":1,"maxLength":500},"job":{"type":"string","minLength":1,"maxLength":200},"productName":{"type":"string","minLength":1,"maxLength":200},"features":{"minItems":6,"maxItems":15,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:/-]*$"},"name":{"type":"string","minLength":1,"maxLength":60},"description":{"type":"string","minLength":1,"maxLength":160}},"required":["id","name","description"],"additionalProperties":false}},"productTask":{"type":"object","properties":{"startUrl":{"type":"string","maxLength":2000,"format":"uri"},"successCriteria":{"type":"string","minLength":1,"maxLength":500}},"required":["startUrl","successCriteria"],"additionalProperties":false}},"required":["version","kind","job","productName","features"],"additionalProperties":false},"ResearchInstrument":{"type":"object","properties":{"version":{"type":"string","const":"research-campaign-spec.v1"},"playbookKey":{"type":"string","enum":["ad_copy","brand_health","offers","pricing","product","product_launch","sales","custom","product_roadmap"]},"templateSlug":{"type":"string","minLength":1,"maxLength":256},"templateVersion":{"type":"integer","minimum":1,"maximum":9007199254740991},"stimulus":{"$ref":"#/components/schemas/ResearchStimulus2"},"questions":{"minItems":1,"maxItems":100,"type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:/-]*$"},"title":{"type":"string","minLength":1,"maxLength":500},"prompt":{"type":"string","minLength":1,"maxLength":10000},"shape":{"type":"string","const":"open_ended"}},"required":["id","title","prompt","shape"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:/-]*$"},"title":{"type":"string","minLength":1,"maxLength":500},"prompt":{"type":"string","minLength":1,"maxLength":10000},"shape":{"type":"string","enum":["closed_ended","multi_select","rank","matrix","scale"]},"options":{"minItems":2,"maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":500}}},"required":["id","title","prompt","shape","options"],"additionalProperties":false}]}},"resultContract":{"type":"object","properties":{"version":{"type":"string","const":"research-result-contract.v1"},"observationKinds":{"minItems":1,"maxItems":6,"type":"array","items":{"type":"string","enum":["choice","rating","ranking","open_text","task_outcome","conversation_rubric"]}}},"required":["version","observationKinds"],"additionalProperties":false},"scorer":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[a-z][a-z0-9._-]*$"},"version":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["id","version"],"additionalProperties":false}},"required":["version","playbookKey","templateSlug","templateVersion","stimulus","questions","resultContract","scorer"],"additionalProperties":false},"ResearchStimulus2":{"oneOf":[{"type":"object","properties":{"version":{"type":"string","const":"research-stimulus.v1"},"kind":{"type":"string","const":"brand"},"title":{"type":"string","minLength":1,"maxLength":500},"brand":{"type":"string","minLength":1,"maxLength":200},"category":{"type":"string","minLength":1,"maxLength":200},"competitors":{"maxItems":5,"type":"array","items":{"type":"string","minLength":1,"maxLength":200}},"startUrl":{"type":"string","maxLength":2000,"format":"uri"},"shownList":{"type":"array","items":{"type":"string"}}},"required":["version","kind","brand","competitors"],"additionalProperties":false},{"type":"object","properties":{"version":{"type":"string","const":"research-stimulus.v1"},"kind":{"type":"string","const":"copy"},"title":{"type":"string","minLength":1,"maxLength":500},"copies":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:/-]*$"},"label":{"type":"string","minLength":1,"maxLength":200},"body":{"type":"string","minLength":1,"maxLength":10000}},"required":["id","body"],"additionalProperties":false}}},"required":["version","kind","copies"],"additionalProperties":false},{"$ref":"#/components/schemas/ResearchStimulusVariant"},{"type":"object","properties":{"version":{"type":"string","const":"research-stimulus.v1"},"kind":{"type":"string","const":"concept"},"title":{"type":"string","minLength":1,"maxLength":500},"concepts":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:/-]*$"},"title":{"type":"string","minLength":1,"maxLength":500},"description":{"type":"string","minLength":1,"maxLength":10000},"assetRefs":{"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":512}},"prototypeUrl":{"type":"string","maxLength":2000,"format":"uri"},"buyerGoal":{"type":"string","minLength":1,"maxLength":120}},"required":["id","title","description"],"additionalProperties":false}}},"required":["version","kind","concepts"],"additionalProperties":false},{"$ref":"#/components/schemas/ResearchStimulusVariant2"},{"$ref":"#/components/schemas/ResearchStimulusVariant3"},{"type":"object","properties":{"version":{"type":"string","const":"research-stimulus.v1"},"kind":{"type":"string","const":"task"},"title":{"type":"string","minLength":1,"maxLength":500},"instructions":{"type":"string","minLength":1,"maxLength":10000},"destinationUrl":{"type":"string","maxLength":2048,"format":"uri"},"problem":{"type":"string","minLength":1,"maxLength":120},"keyMessage":{"type":"string","minLength":1,"maxLength":200}},"required":["version","kind","title","instructions"],"additionalProperties":false},{"type":"object","properties":{"version":{"type":"string","const":"research-stimulus.v1"},"kind":{"type":"string","const":"custom"},"title":{"type":"string","minLength":1,"maxLength":500},"content":{"type":"string","minLength":1,"maxLength":10000},"assetRefs":{"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":512}},"private":{"type":"boolean","const":true}},"required":["version","kind","content"],"additionalProperties":false},{"$ref":"#/components/schemas/ResearchStimulusVariant4"}]},"ResearchInstrument2":{"type":"object","properties":{"version":{"type":"string","const":"research-campaign-spec.v2"},"playbookKey":{"type":"string","enum":["ad_copy","brand_health","offers","pricing","product","product_launch","sales","custom","product_roadmap"]},"templateSlug":{"type":"string","minLength":1,"maxLength":256},"templateVersion":{"type":"integer","minimum":1,"maximum":9007199254740991},"stimulus":{"$ref":"#/components/schemas/ResearchStimulus2"},"questions":{"type":"array","items":{"$ref":"#/components/schemas/ResearchQuestionsItem2"}},"resultContract":{"type":"object","properties":{"version":{"type":"string","const":"research-result-contract.v1"},"observationKinds":{"minItems":1,"maxItems":6,"type":"array","items":{"type":"string","enum":["choice","rating","ranking","open_text","task_outcome","conversation_rubric"]}}},"required":["version","observationKinds"],"additionalProperties":false},"scorer":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[a-z][a-z0-9._-]*$"},"version":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["id","version"],"additionalProperties":false}},"required":["version","playbookKey","templateSlug","templateVersion","stimulus","questions","resultContract","scorer"],"additionalProperties":false},"ResearchQuestionsItem2":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:/-]*$"},"title":{"type":"string","minLength":1,"maxLength":500},"prompt":{"type":"string","minLength":1,"maxLength":10000},"shape":{"type":"string","const":"open_ended"},"flow":{"$ref":"#/components/schemas/ResearchFlow"}},"required":["id","title","prompt","shape"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:/-]*$"},"title":{"type":"string","minLength":1,"maxLength":500},"prompt":{"type":"string","minLength":1,"maxLength":10000},"shape":{"type":"string","enum":["closed_ended","multi_select","rank","matrix","scale"]},"options":{"minItems":2,"maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":500}},"flow":{"$ref":"#/components/schemas/ResearchFlow"}},"required":["id","title","prompt","shape","options"],"additionalProperties":false}]},"ResearchInstrument3":{"type":"object","properties":{"version":{"type":"string","const":"research-campaign-spec.v3"},"playbookKey":{"type":"string","enum":["ad_copy","brand_health","offers","pricing","product","product_launch","sales","custom","product_roadmap"]},"templateSlug":{"type":"string","minLength":1,"maxLength":256},"templateVersion":{"type":"integer","minimum":1,"maximum":9007199254740991},"stimulus":{"$ref":"#/components/schemas/ResearchStimulus2"},"questions":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/ResearchQuestionsItem2"},{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:/-]*$"},"title":{"type":"string","minLength":1,"maxLength":500},"prompt":{"type":"string","minLength":1,"maxLength":10000},"shape":{"type":"string","const":"computer_task"},"targets":{"$ref":"#/components/schemas/ResearchItemTargets"},"successCriteria":{"type":"string","minLength":1,"maxLength":10000},"flow":{"$ref":"#/components/schemas/ResearchFlow"}},"required":["id","title","prompt","shape","targets","successCriteria"],"additionalProperties":false}]}},"resultContract":{"type":"object","properties":{"version":{"type":"string","const":"research-result-contract.v1"},"observationKinds":{"minItems":1,"maxItems":6,"type":"array","items":{"type":"string","enum":["choice","rating","ranking","open_text","task_outcome","conversation_rubric"]}}},"required":["version","observationKinds"],"additionalProperties":false},"scorer":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[a-z][a-z0-9._-]*$"},"version":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["id","version"],"additionalProperties":false}},"required":["version","playbookKey","templateSlug","templateVersion","stimulus","questions","resultContract","scorer"],"additionalProperties":false},"ResearchItemTargets":{"minItems":1,"maxItems":5,"type":"array","items":{"anyOf":[{"type":"object","properties":{"version":{"type":"string","const":"research-computer-target.v1"},"platform":{"type":"string","const":"website"},"device":{"type":"string","const":"desktop"},"startUrl":{"type":"string","maxLength":2000,"format":"uri"},"access":{"type":"object","properties":{"connection":{"type":"object","properties":{"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["connectionId","revision"],"additionalProperties":false},"account":{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["accountId","revision"],"additionalProperties":false}},"required":["connection"],"additionalProperties":false}},"required":["version","platform","device","startUrl"],"additionalProperties":false},{"type":"object","properties":{"version":{"type":"string","const":"research-computer-target.v1"},"platform":{"type":"string","const":"website"},"device":{"type":"string","enum":["ios","android"]},"startUrl":{"type":"string","maxLength":2000,"format":"uri"},"deviceName":{"type":"string","minLength":1,"maxLength":120},"osVersion":{"type":"string","minLength":1,"maxLength":80},"access":{"type":"object","properties":{"connection":{"type":"object","properties":{"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["connectionId","revision"],"additionalProperties":false},"account":{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["accountId","revision"],"additionalProperties":false}},"required":["connection"],"additionalProperties":false}},"required":["version","platform","device","startUrl","deviceName","osVersion"],"additionalProperties":false},{"type":"object","properties":{"version":{"type":"string","const":"research-computer-target.v1"},"platform":{"type":"string","enum":["ios","android"]},"access":{"type":"object","properties":{"connection":{"type":"object","properties":{"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["connectionId","revision"],"additionalProperties":false},"account":{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["accountId","revision"],"additionalProperties":false}},"required":["connection"],"additionalProperties":false},"nativeApp":{"type":"object","properties":{"platform":{"type":"string","enum":["ios","android"]},"buildId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$"},"appId":{"type":"string","minLength":1,"maxLength":255},"versionLabel":{"type":"string","minLength":1,"maxLength":120},"deviceName":{"type":"string","minLength":1,"maxLength":120},"osVersion":{"type":"string","minLength":1,"maxLength":80}},"required":["platform","buildId","sha256","appId","versionLabel","deviceName","osVersion"],"additionalProperties":false}},"required":["version","platform","access","nativeApp"],"additionalProperties":false}]}},"ResearchInstrument4":{"type":"object","properties":{"version":{"type":"string","const":"research-campaign-spec.v4"},"playbookKey":{"type":"string","enum":["ad_copy","brand_health","offers","pricing","product","product_launch","sales","custom","product_roadmap"]},"templateSlug":{"type":"string","minLength":1,"maxLength":256},"templateVersion":{"type":"integer","minimum":1,"maximum":9007199254740991},"stimulus":{"$ref":"#/components/schemas/ResearchStimulus2"},"questions":{"$ref":"#/components/schemas/ResearchQuestions"},"resultContract":{"type":"object","properties":{"version":{"type":"string","const":"research-result-contract.v1"},"observationKinds":{"minItems":1,"maxItems":6,"type":"array","items":{"type":"string","enum":["choice","rating","ranking","open_text","task_outcome","conversation_rubric"]}}},"required":["version","observationKinds"],"additionalProperties":false},"scorer":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[a-z][a-z0-9._-]*$"},"version":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["id","version"],"additionalProperties":false},"presentationOrder":{"type":"string","const":"per_participant"}},"required":["version","playbookKey","templateSlug","templateVersion","stimulus","questions","resultContract","scorer"],"additionalProperties":false},"ResearchQuestions":{"minItems":1,"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/ResearchItem"}},"ResearchItem":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:/-]*$"},"title":{"type":"string","minLength":1,"maxLength":500},"prompt":{"type":"string","minLength":1,"maxLength":10000},"shape":{"type":"string","const":"open_ended"},"flow":{"$ref":"#/components/schemas/ResearchFlow"},"attachment":{"$ref":"#/components/schemas/ResearchAttachment"},"blind":{"type":"boolean","const":true},"stimulusItemId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:/-]*$"}},"required":["id","title","prompt","shape"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:/-]*$"},"title":{"type":"string","minLength":1,"maxLength":500},"prompt":{"type":"string","minLength":1,"maxLength":10000},"shape":{"type":"string","enum":["closed_ended","multi_select","rank","matrix","scale"]},"options":{"minItems":2,"maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":500}},"flow":{"$ref":"#/components/schemas/ResearchFlow"},"attachment":{"$ref":"#/components/schemas/ResearchAttachment"},"blind":{"type":"boolean","const":true},"stimulusItemId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:/-]*$"},"maxSelections":{"type":"integer","minimum":1,"maximum":9007199254740991},"unaided":{"type":"boolean","const":true}},"required":["id","title","prompt","shape","options"],"additionalProperties":false},{"$ref":"#/components/schemas/ResearchItemVariant"}]},"ResearchAttachment":{"oneOf":[{"type":"object","properties":{"version":{"type":"string","const":"research-question-attachment.v1"},"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":4194304},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$"}},"required":["version","artifactId","filename","mediaType","byteLength","sha256"],"additionalProperties":false},{"$ref":"#/components/schemas/ResearchAttachmentVariant"},{"type":"object","properties":{"version":{"type":"string","const":"research-question-attachment.v3"},"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["audio/mpeg","audio/wav"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":4194304},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$"}},"required":["version","artifactId","filename","mediaType","byteLength","sha256"],"additionalProperties":false}]},"ResearchAttachmentVariant":{"type":"object","properties":{"version":{"type":"string","const":"research-question-attachment.v2"},"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["video/mp4","video/webm"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":104857600},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$"},"durationMs":{"type":"integer","minimum":1,"maximum":180000},"storyboard":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$"},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":2097152},"modelByteLength":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["artifactId","sha256","byteLength","modelByteLength"],"additionalProperties":false}},"required":["version","artifactId","filename","mediaType","byteLength","sha256","durationMs","storyboard"],"additionalProperties":false},"ResearchItemVariant":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:/-]*$"},"title":{"type":"string","minLength":1,"maxLength":500},"prompt":{"type":"string","minLength":1,"maxLength":10000},"shape":{"type":"string","const":"computer_task"},"targets":{"$ref":"#/components/schemas/ResearchItemTargets"},"successCriteria":{"type":"string","minLength":1,"maxLength":10000},"flow":{"$ref":"#/components/schemas/ResearchFlow"},"attachment":{"type":"object","properties":{"version":{"type":"string","const":"research-question-attachment.v1"},"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":4194304},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$"}},"required":["version","artifactId","filename","mediaType","byteLength","sha256"],"additionalProperties":false},"blind":{"type":"boolean","const":true},"stimulusItemId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:/-]*$"}},"required":["id","title","prompt","shape","targets","successCriteria"],"additionalProperties":false},"ResearchInstrument5":{"type":"object","properties":{"subtype":{"type":"string","enum":["ad_copy","brand_health","offers","pricing","product","product_launch","sales","custom","product_roadmap","purchasing","competitors"]},"templateSlug":{"type":"string"},"templateVersion":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"questions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"prompt":{"type":"string"},"shape":{"type":"string","enum":["open_ended","closed_ended","rank","matrix","scale"]},"options":{"type":"array","items":{"type":"string"}},"gate":{"type":"object","properties":{"id":{"type":"string"},"readQuestionId":{"type":"string"},"branches":{"type":"array","items":{"type":"object","properties":{"when":{"type":"string"},"nextQuestionId":{"type":"string"}},"required":["when","nextQuestionId"],"additionalProperties":false}}},"required":["id","readQuestionId","branches"],"additionalProperties":false}},"required":["id","title","prompt","shape"],"additionalProperties":false}}},"required":["subtype","templateSlug","templateVersion","questions"],"additionalProperties":false},"ResearchInstrumentQuestionsItem":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:/-]*$"},"title":{"type":"string","minLength":1,"maxLength":500},"prompt":{"type":"string","minLength":1,"maxLength":10000},"shape":{"type":"string","const":"open_ended"},"flow":{"$ref":"#/components/schemas/ResearchFlow"},"attachment":{"$ref":"#/components/schemas/ResearchAttachment2"},"blind":{"type":"boolean","const":true},"stimulusItemId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:/-]*$"}},"required":["id","title","prompt","shape"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:/-]*$"},"title":{"type":"string","minLength":1,"maxLength":500},"prompt":{"type":"string","minLength":1,"maxLength":10000},"shape":{"type":"string","enum":["closed_ended","multi_select","rank","matrix","scale"]},"options":{"minItems":2,"maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":500}},"flow":{"$ref":"#/components/schemas/ResearchFlow"},"attachment":{"$ref":"#/components/schemas/ResearchAttachment2"},"blind":{"type":"boolean","const":true},"stimulusItemId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:/-]*$"},"maxSelections":{"type":"integer","minimum":1,"maximum":9007199254740991},"unaided":{"type":"boolean","const":true}},"required":["id","title","prompt","shape","options"],"additionalProperties":false},{"$ref":"#/components/schemas/ResearchItemVariant"}]},"ResearchAttachment2":{"oneOf":[{"type":"object","properties":{"version":{"type":"string","const":"research-question-attachment.v1"},"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":4194304},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$"}},"required":["version","artifactId","filename","mediaType","byteLength","sha256"],"additionalProperties":false},{"$ref":"#/components/schemas/ResearchAttachmentVariant"}]},"ResearchInstrumentQuestionsItem2":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:/-]*$"},"title":{"type":"string","minLength":1,"maxLength":500},"prompt":{"type":"string","minLength":1,"maxLength":10000},"shape":{"type":"string","const":"open_ended"},"flow":{"$ref":"#/components/schemas/ResearchFlow"},"attachment":{"type":"object","properties":{"version":{"type":"string","const":"research-question-attachment.v1"},"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":4194304},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$"}},"required":["version","artifactId","filename","mediaType","byteLength","sha256"],"additionalProperties":false},"blind":{"type":"boolean","const":true},"stimulusItemId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:/-]*$"}},"required":["id","title","prompt","shape"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:/-]*$"},"title":{"type":"string","minLength":1,"maxLength":500},"prompt":{"type":"string","minLength":1,"maxLength":10000},"shape":{"type":"string","enum":["closed_ended","multi_select","rank","matrix","scale"]},"options":{"minItems":2,"maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":500}},"flow":{"$ref":"#/components/schemas/ResearchFlow"},"attachment":{"type":"object","properties":{"version":{"type":"string","const":"research-question-attachment.v1"},"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":4194304},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$"}},"required":["version","artifactId","filename","mediaType","byteLength","sha256"],"additionalProperties":false},"blind":{"type":"boolean","const":true},"stimulusItemId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:/-]*$"},"maxSelections":{"type":"integer","minimum":1,"maximum":9007199254740991},"unaided":{"type":"boolean","const":true}},"required":["id","title","prompt","shape","options"],"additionalProperties":false},{"$ref":"#/components/schemas/ResearchItemVariant"}]},"ResearchComputerResults":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"questionId":{"type":"string"},"title":{"type":"string"},"targetKey":{"type":"string","enum":["website:desktop","website:ios","website:android","ios","android"]},"status":{"anyOf":[{"type":"string","enum":["scheduled","waiting","running","completed","failed","cancelled"]},{"type":"null"}]},"achieved":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether the task succeeded; null until it settles."},"outcomeSummary":{"anyOf":[{"type":"string"},{"type":"null"}]},"experienceRunId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["id","questionId","title","targetKey","status","achieved","outcomeSummary","experienceRunId"],"additionalProperties":false}},"ResearchPending":{"type":"object","properties":{"brief":{"type":"string","maxLength":32000},"attachments":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm","audio/mpeg","audio/wav"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":104857600}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false}},"request":{"type":"object","properties":{"operationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"profileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"contentLanguage":{"type":"string","enum":["en","fr","es","de","pt","ja","it","nl","sv","cs","pl","tr","ru","zh-Hans","ko","ar"]},"design":{"$ref":"#/components/schemas/ResearchDesign"}},"required":["operationId","profileId","design"],"additionalProperties":false}},"required":["brief","attachments","request"],"additionalProperties":false},"ResearchDesign":{"type":"object","properties":{"kind":{"description":"backtest when the study re-asks a decision the business already made, as its people faced it then. Omit it for any other study.","type":"string","const":"backtest"},"conversation":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","enum":["user","assistant"]},"content":{"type":"string","minLength":1,"maxLength":32000}},"required":["role","content"],"additionalProperties":false}},"attachments":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm","audio/mpeg","audio/wav"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":104857600}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false}}},"required":["messages","attachments"],"additionalProperties":false},"name":{"type":"string","maxLength":120},"goal":{"type":"string","maxLength":10000},"summary":{"type":"string","maxLength":500},"questions":{"$ref":"#/components/schemas/ResearchQuestions2"},"assumptions":{"maxItems":10,"type":"array","items":{"type":"string","maxLength":10000},"description":"Customer assumptions: statements every respondent answers as true of themselves for this study only, beside their own profile, in order. Empty when the study states none."},"decision":{"description":"For a backtest only: its current decision question and what each option keeps. Omit it when there is none.","type":"object","properties":{"questionId":{"type":"string","minLength":1,"description":"The single-choice question that asks the decision."},"keeps":{"minItems":1,"maxItems":100,"type":"array","items":{"anyOf":[{"type":"number","minimum":0,"maximum":2},{"type":"null"}]},"description":"By option position: the share of usual buying the answer keeps (0 stops, 1 keeps, up to 2 buys more), or null to leave it out."}},"required":["questionId","keeps"],"additionalProperties":false},"authorEditedQuestions":{"description":"The questions in `questions` the author wrote or edited by hand since Alpha last delivered a study, which Alpha keeps as written unless the latest message asks to change them. Omit it when there are none.","maxItems":100,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"description":"The question's ID in `questions`."},"title":{"type":"string","maxLength":500,"description":"The question's title as the author left it."},"prompt":{"type":"string","maxLength":10000,"description":"The question's wording as the author left it."}},"required":["id","title","prompt"],"additionalProperties":false}}},"required":["conversation","name","goal","questions"],"additionalProperties":false},"ResearchQuestions2":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/ResearchQuestionsItem"}},"ResearchProposalDesign":{"type":"object","properties":{"message":{"type":"string","minLength":1,"maxLength":32000},"study":{"anyOf":[{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"goal":{"type":"string","maxLength":10000},"summary":{"type":"string","maxLength":500},"questions":{"minItems":1,"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/ResearchQuestionsItem"}},"assumptions":{"maxItems":10,"type":"array","items":{"type":"string","maxLength":10000},"description":"Customer assumptions: statements every respondent answers as true of themselves for this study only, beside their own profile, in order. Empty when the study states none."},"decision":{"description":"For a backtest only: the single-choice question that asks the decision and what each of its options keeps. Omit it for any other study.","type":"object","properties":{"questionId":{"type":"string","minLength":1,"description":"The single-choice question that asks the decision."},"keeps":{"minItems":1,"maxItems":100,"type":"array","items":{"anyOf":[{"type":"number","minimum":0,"maximum":2},{"type":"null"}]},"description":"By option position: the share of usual buying the answer keeps (0 stops, 1 keeps, up to 2 buys more), or null to leave it out."}},"required":["questionId","keeps"],"additionalProperties":false}},"required":["name","goal","summary","questions"],"additionalProperties":false},{"type":"null"}]}},"required":["message","study"],"additionalProperties":false},"ResearchMaterial":{"oneOf":[{"type":"object","properties":{"version":{"type":"string","const":"research-stimulus.v1"},"title":{"type":"string","maxLength":500},"kind":{"type":"string","const":"copy"},"copies":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128},"label":{"type":"string","maxLength":500},"body":{"type":"string","maxLength":10000}},"required":["id","body"],"additionalProperties":false}}},"required":["version","kind","copies"],"additionalProperties":false},{"type":"object","properties":{"version":{"type":"string","const":"research-stimulus.v1"},"title":{"type":"string","maxLength":500},"kind":{"type":"string","const":"ads"},"format":{"type":"string","enum":["full_ad","headline","tagline","product_name","email_subject","social_post"]},"placement":{"type":"string","maxLength":120},"ads":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128},"headline":{"type":"string","maxLength":500},"body":{"type":"string","maxLength":10000},"callToAction":{"type":"string","maxLength":500},"landingUrl":{"type":"string","maxLength":2000},"intendedTakeaway":{"type":"string","maxLength":200}},"required":["id","headline"],"additionalProperties":false}},"files":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","minLength":1,"maxLength":128},"itemId":{"type":"string","minLength":1,"maxLength":128},"attachment":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm","audio/mpeg","audio/wav"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":104857600}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false}},"required":["slot","attachment"],"additionalProperties":false}}},"required":["version","kind","ads"],"additionalProperties":false},{"type":"object","properties":{"version":{"type":"string","const":"research-stimulus.v1"},"title":{"type":"string","maxLength":500},"kind":{"type":"string","const":"concept"},"concepts":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128},"title":{"type":"string","maxLength":500},"description":{"type":"string","maxLength":10000},"assetRefs":{"maxItems":20,"type":"array","items":{"type":"string","maxLength":512}},"prototypeUrl":{"type":"string","maxLength":2000},"buyerGoal":{"type":"string","maxLength":120}},"required":["id","title","description"],"additionalProperties":false}},"files":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","minLength":1,"maxLength":128},"itemId":{"type":"string","minLength":1,"maxLength":128},"attachment":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm","audio/mpeg","audio/wav"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":104857600}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false}},"required":["slot","attachment"],"additionalProperties":false}}},"required":["version","kind","concepts"],"additionalProperties":false},{"type":"object","properties":{"version":{"type":"string","const":"research-stimulus.v1"},"title":{"type":"string","maxLength":500},"kind":{"type":"string","const":"offer_set"},"offers":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128},"title":{"type":"string","maxLength":500},"description":{"type":"string","maxLength":10000},"terms":{"type":"string","maxLength":5000}},"required":["id","title","description"],"additionalProperties":false}},"category":{"type":"string","maxLength":200},"liveOffer":{"type":"object","properties":{"offerId":{"type":"string","maxLength":128},"url":{"type":"string","maxLength":2048}},"required":["offerId","url"],"additionalProperties":false},"files":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","minLength":1,"maxLength":128},"itemId":{"type":"string","minLength":1,"maxLength":128},"attachment":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm","audio/mpeg","audio/wav"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":104857600}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false}},"required":["slot","attachment"],"additionalProperties":false}}},"required":["version","kind","offers"],"additionalProperties":false},{"type":"object","properties":{"version":{"type":"string","const":"research-stimulus.v1"},"title":{"type":"string","maxLength":500},"kind":{"type":"string","const":"price_ladder"},"description":{"type":"string","maxLength":10000},"currency":{"type":"string","maxLength":10},"billingUnit":{"type":"string","enum":["one_time","per_month","per_year","per_seat_per_month"]},"prices":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128},"amount":{"type":"string","maxLength":100},"label":{"type":"string","maxLength":500}},"required":["id","amount"],"additionalProperties":false}},"plannedPriceId":{"type":"string","minLength":1,"maxLength":128},"category":{"type":"string","maxLength":200},"alternatives":{"maxItems":3,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128},"name":{"type":"string","maxLength":60},"amount":{"type":"string","maxLength":100}},"required":["id","name","amount"],"additionalProperties":false}},"plans":{"maxItems":4,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128},"name":{"type":"string","maxLength":60}},"required":["id","name"],"additionalProperties":false}},"pricingPageUrl":{"type":"string","maxLength":2048},"files":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","minLength":1,"maxLength":128},"itemId":{"type":"string","minLength":1,"maxLength":128},"attachment":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm","audio/mpeg","audio/wav"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":104857600}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false}},"required":["slot","attachment"],"additionalProperties":false}}},"required":["version","title","kind","currency","prices"],"additionalProperties":false},{"type":"object","properties":{"version":{"type":"string","const":"research-stimulus.v1"},"title":{"type":"string","maxLength":500},"kind":{"type":"string","const":"task"},"instructions":{"type":"string","maxLength":10000},"destinationUrl":{"type":"string","maxLength":2048},"problem":{"type":"string","maxLength":120},"keyMessage":{"type":"string","maxLength":200},"files":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","minLength":1,"maxLength":128},"itemId":{"type":"string","minLength":1,"maxLength":128},"attachment":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm","audio/mpeg","audio/wav"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":104857600}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false}},"required":["slot","attachment"],"additionalProperties":false}}},"required":["version","title","kind","instructions"],"additionalProperties":false},{"type":"object","properties":{"version":{"type":"string","const":"research-stimulus.v1"},"title":{"type":"string","maxLength":500},"kind":{"type":"string","const":"custom"},"content":{"type":"string","maxLength":10000},"assetRefs":{"maxItems":20,"type":"array","items":{"type":"string","maxLength":512}}},"required":["version","kind","content"],"additionalProperties":false},{"type":"object","properties":{"version":{"type":"string","const":"research-stimulus.v1"},"title":{"type":"string","maxLength":500},"kind":{"type":"string","const":"brand"},"brand":{"type":"string","maxLength":500},"category":{"type":"string","maxLength":200},"competitors":{"maxItems":5,"type":"array","items":{"type":"string","maxLength":500}},"startUrl":{"type":"string","maxLength":2048}},"required":["version","kind","category","competitors"],"additionalProperties":false},{"type":"object","properties":{"version":{"type":"string","const":"research-stimulus.v1"},"title":{"type":"string","maxLength":500},"kind":{"type":"string","const":"features"},"job":{"type":"string","maxLength":200},"productName":{"type":"string","maxLength":200},"features":{"maxItems":15,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128},"name":{"type":"string","maxLength":60},"description":{"type":"string","maxLength":160}},"required":["id","name","description"],"additionalProperties":false}},"productTask":{"type":"object","properties":{"startUrl":{"type":"string","maxLength":2000},"successCriteria":{"type":"string","maxLength":500}},"required":["startUrl","successCriteria"],"additionalProperties":false},"files":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","minLength":1,"maxLength":128},"itemId":{"type":"string","minLength":1,"maxLength":128},"attachment":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm","audio/mpeg","audio/wav"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":104857600}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false}},"required":["slot","attachment"],"additionalProperties":false}}},"required":["version","kind","job","features"],"additionalProperties":false}]},"ResearchStimulus3":{"anyOf":[{"$ref":"#/components/schemas/ResearchStimulus2"},{"type":"null"}]},"ResearchBacktest":{"type":"object","properties":{"decision":{"type":"object","properties":{"questionId":{"type":"string","minLength":1,"description":"The single-choice question that asks the decision."},"keeps":{"minItems":1,"maxItems":100,"type":"array","items":{"anyOf":[{"type":"number","minimum":0,"maximum":2},{"type":"null"}]},"description":"By option position: the share of usual buying the answer keeps (0 stops, 1 keeps, up to 2 buys more), or null to leave it out."}},"required":["questionId","keeps"],"additionalProperties":false},"outcome":{"type":"object","properties":{"metric":{"type":"string","minLength":1,"maxLength":120,"description":"What was measured, such as \"Units sold a week\"."},"change":{"type":"number","minimum":-1,"maximum":100,"description":"The measured change, as a fraction: -0.3 is a 30% drop."},"note":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]}},"required":["metric","change"],"additionalProperties":false}},"additionalProperties":false},"ResearchDesignerPending":{"type":"object","properties":{"brief":{"type":"string","maxLength":32000},"attachments":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":104857600}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false}},"request":{"type":"object","properties":{"operationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"profileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"contentLanguage":{"type":"string","enum":["en","fr","es","de","pt","ja","it","nl","sv","cs","pl","tr","ru","zh-Hans","ko","ar"]},"design":{"$ref":"#/components/schemas/ResearchRequestDesign"}},"required":["operationId","profileId","design"],"additionalProperties":false}},"required":["brief","attachments","request"],"additionalProperties":false},"ResearchRequestDesign":{"type":"object","properties":{"kind":{"description":"backtest when the study re-asks a decision the business already made, as its people faced it then. Omit it for any other study.","type":"string","const":"backtest"},"conversation":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","enum":["user","assistant"]},"content":{"type":"string","minLength":1,"maxLength":32000}},"required":["role","content"],"additionalProperties":false}},"attachments":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":104857600}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false}}},"required":["messages","attachments"],"additionalProperties":false},"name":{"type":"string","maxLength":120},"goal":{"type":"string","maxLength":10000},"summary":{"type":"string","maxLength":500},"questions":{"$ref":"#/components/schemas/ResearchQuestions3"},"assumptions":{"maxItems":10,"type":"array","items":{"type":"string","maxLength":10000},"description":"Customer assumptions: statements every respondent answers as true of themselves for this study only, beside their own profile, in order. Empty when the study states none."},"decision":{"description":"For a backtest only: its current decision question and what each option keeps. Omit it when there is none.","type":"object","properties":{"questionId":{"type":"string","minLength":1,"description":"The single-choice question that asks the decision."},"keeps":{"minItems":1,"maxItems":100,"type":"array","items":{"anyOf":[{"type":"number","minimum":0,"maximum":2},{"type":"null"}]},"description":"By option position: the share of usual buying the answer keeps (0 stops, 1 keeps, up to 2 buys more), or null to leave it out."}},"required":["questionId","keeps"],"additionalProperties":false},"authorEditedQuestions":{"description":"The questions in `questions` the author wrote or edited by hand since Alpha last delivered a study, which Alpha keeps as written unless the latest message asks to change them. Omit it when there are none.","maxItems":100,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"description":"The question's ID in `questions`."},"title":{"type":"string","maxLength":500,"description":"The question's title as the author left it."},"prompt":{"type":"string","maxLength":10000,"description":"The question's wording as the author left it."}},"required":["id","title","prompt"],"additionalProperties":false}}},"required":["conversation","name","goal","questions"],"additionalProperties":false},"ResearchQuestions3":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/ResearchItem2"}},"ResearchItem2":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128},"title":{"type":"string","maxLength":500},"prompt":{"type":"string","maxLength":10000},"flow":{"$ref":"#/components/schemas/ResearchFlow"},"attachment":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":104857600}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false},"stimulusItemId":{"type":"string","minLength":1,"maxLength":128},"blind":{"type":"boolean","const":true},"shape":{"type":"string","const":"open_ended"}},"required":["id","title","prompt","shape"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128},"title":{"type":"string","maxLength":500},"prompt":{"type":"string","maxLength":10000},"flow":{"$ref":"#/components/schemas/ResearchFlow"},"attachment":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":104857600}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false},"stimulusItemId":{"type":"string","minLength":1,"maxLength":128},"blind":{"type":"boolean","const":true},"shape":{"type":"string","enum":["closed_ended","multi_select","rank","matrix","scale"]},"options":{"maxItems":100,"type":"array","items":{"type":"string","maxLength":500}},"maxSelections":{"type":"integer","minimum":1,"maximum":100},"unaided":{"type":"boolean","const":true}},"required":["id","title","prompt","shape","options"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128},"title":{"type":"string","maxLength":500},"prompt":{"type":"string","maxLength":10000},"flow":{"$ref":"#/components/schemas/ResearchFlow"},"attachment":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":104857600}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false},"stimulusItemId":{"type":"string","minLength":1,"maxLength":128},"blind":{"type":"boolean","const":true},"shape":{"type":"string","const":"computer_task"},"targets":{"$ref":"#/components/schemas/ResearchTargets"},"successCriteria":{"type":"string","maxLength":10000}},"required":["id","title","prompt","shape","targets","successCriteria"],"additionalProperties":false}]},"ResearchDesignerProposalDesign":{"type":"object","properties":{"message":{"type":"string","minLength":1,"maxLength":32000},"study":{"anyOf":[{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"goal":{"type":"string","maxLength":10000},"summary":{"type":"string","maxLength":500},"questions":{"minItems":1,"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/ResearchItem2"}},"assumptions":{"maxItems":10,"type":"array","items":{"type":"string","maxLength":10000},"description":"Customer assumptions: statements every respondent answers as true of themselves for this study only, beside their own profile, in order. Empty when the study states none."},"decision":{"description":"For a backtest only: the single-choice question that asks the decision and what each of its options keeps. Omit it for any other study.","type":"object","properties":{"questionId":{"type":"string","minLength":1,"description":"The single-choice question that asks the decision."},"keeps":{"minItems":1,"maxItems":100,"type":"array","items":{"anyOf":[{"type":"number","minimum":0,"maximum":2},{"type":"null"}]},"description":"By option position: the share of usual buying the answer keeps (0 stops, 1 keeps, up to 2 buys more), or null to leave it out."}},"required":["questionId","keeps"],"additionalProperties":false}},"required":["name","goal","summary","questions"],"additionalProperties":false},{"type":"null"}]}},"required":["message","study"],"additionalProperties":false},"ResearchMaterial2":{"oneOf":[{"type":"object","properties":{"version":{"type":"string","const":"research-stimulus.v1"},"title":{"type":"string","maxLength":500},"kind":{"type":"string","const":"copy"},"copies":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128},"label":{"type":"string","maxLength":500},"body":{"type":"string","maxLength":10000}},"required":["id","body"],"additionalProperties":false}}},"required":["version","kind","copies"],"additionalProperties":false},{"type":"object","properties":{"version":{"type":"string","const":"research-stimulus.v1"},"title":{"type":"string","maxLength":500},"kind":{"type":"string","const":"ads"},"format":{"type":"string","enum":["full_ad","headline","tagline","product_name","email_subject","social_post"]},"placement":{"type":"string","maxLength":120},"ads":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128},"headline":{"type":"string","maxLength":500},"body":{"type":"string","maxLength":10000},"callToAction":{"type":"string","maxLength":500},"landingUrl":{"type":"string","maxLength":2000},"intendedTakeaway":{"type":"string","maxLength":200}},"required":["id","headline"],"additionalProperties":false}},"files":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","minLength":1,"maxLength":128},"itemId":{"type":"string","minLength":1,"maxLength":128},"attachment":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":104857600}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false}},"required":["slot","attachment"],"additionalProperties":false}}},"required":["version","kind","ads"],"additionalProperties":false},{"type":"object","properties":{"version":{"type":"string","const":"research-stimulus.v1"},"title":{"type":"string","maxLength":500},"kind":{"type":"string","const":"concept"},"concepts":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128},"title":{"type":"string","maxLength":500},"description":{"type":"string","maxLength":10000},"assetRefs":{"maxItems":20,"type":"array","items":{"type":"string","maxLength":512}},"prototypeUrl":{"type":"string","maxLength":2000},"buyerGoal":{"type":"string","maxLength":120}},"required":["id","title","description"],"additionalProperties":false}},"files":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","minLength":1,"maxLength":128},"itemId":{"type":"string","minLength":1,"maxLength":128},"attachment":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":104857600}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false}},"required":["slot","attachment"],"additionalProperties":false}}},"required":["version","kind","concepts"],"additionalProperties":false},{"type":"object","properties":{"version":{"type":"string","const":"research-stimulus.v1"},"title":{"type":"string","maxLength":500},"kind":{"type":"string","const":"offer_set"},"offers":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128},"title":{"type":"string","maxLength":500},"description":{"type":"string","maxLength":10000},"terms":{"type":"string","maxLength":5000}},"required":["id","title","description"],"additionalProperties":false}},"category":{"type":"string","maxLength":200},"liveOffer":{"type":"object","properties":{"offerId":{"type":"string","maxLength":128},"url":{"type":"string","maxLength":2048}},"required":["offerId","url"],"additionalProperties":false},"files":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","minLength":1,"maxLength":128},"itemId":{"type":"string","minLength":1,"maxLength":128},"attachment":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":104857600}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false}},"required":["slot","attachment"],"additionalProperties":false}}},"required":["version","kind","offers"],"additionalProperties":false},{"type":"object","properties":{"version":{"type":"string","const":"research-stimulus.v1"},"title":{"type":"string","maxLength":500},"kind":{"type":"string","const":"price_ladder"},"description":{"type":"string","maxLength":10000},"currency":{"type":"string","maxLength":10},"billingUnit":{"type":"string","enum":["one_time","per_month","per_year","per_seat_per_month"]},"prices":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128},"amount":{"type":"string","maxLength":100},"label":{"type":"string","maxLength":500}},"required":["id","amount"],"additionalProperties":false}},"plannedPriceId":{"type":"string","minLength":1,"maxLength":128},"category":{"type":"string","maxLength":200},"alternatives":{"maxItems":3,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128},"name":{"type":"string","maxLength":60},"amount":{"type":"string","maxLength":100}},"required":["id","name","amount"],"additionalProperties":false}},"plans":{"maxItems":4,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128},"name":{"type":"string","maxLength":60}},"required":["id","name"],"additionalProperties":false}},"pricingPageUrl":{"type":"string","maxLength":2048},"files":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","minLength":1,"maxLength":128},"itemId":{"type":"string","minLength":1,"maxLength":128},"attachment":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":104857600}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false}},"required":["slot","attachment"],"additionalProperties":false}}},"required":["version","title","kind","currency","prices"],"additionalProperties":false},{"type":"object","properties":{"version":{"type":"string","const":"research-stimulus.v1"},"title":{"type":"string","maxLength":500},"kind":{"type":"string","const":"task"},"instructions":{"type":"string","maxLength":10000},"destinationUrl":{"type":"string","maxLength":2048},"problem":{"type":"string","maxLength":120},"keyMessage":{"type":"string","maxLength":200},"files":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","minLength":1,"maxLength":128},"itemId":{"type":"string","minLength":1,"maxLength":128},"attachment":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":104857600}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false}},"required":["slot","attachment"],"additionalProperties":false}}},"required":["version","title","kind","instructions"],"additionalProperties":false},{"type":"object","properties":{"version":{"type":"string","const":"research-stimulus.v1"},"title":{"type":"string","maxLength":500},"kind":{"type":"string","const":"custom"},"content":{"type":"string","maxLength":10000},"assetRefs":{"maxItems":20,"type":"array","items":{"type":"string","maxLength":512}}},"required":["version","kind","content"],"additionalProperties":false},{"type":"object","properties":{"version":{"type":"string","const":"research-stimulus.v1"},"title":{"type":"string","maxLength":500},"kind":{"type":"string","const":"brand"},"brand":{"type":"string","maxLength":500},"category":{"type":"string","maxLength":200},"competitors":{"maxItems":5,"type":"array","items":{"type":"string","maxLength":500}},"startUrl":{"type":"string","maxLength":2048}},"required":["version","kind","category","competitors"],"additionalProperties":false},{"type":"object","properties":{"version":{"type":"string","const":"research-stimulus.v1"},"title":{"type":"string","maxLength":500},"kind":{"type":"string","const":"features"},"job":{"type":"string","maxLength":200},"productName":{"type":"string","maxLength":200},"features":{"maxItems":15,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128},"name":{"type":"string","maxLength":60},"description":{"type":"string","maxLength":160}},"required":["id","name","description"],"additionalProperties":false}},"productTask":{"type":"object","properties":{"startUrl":{"type":"string","maxLength":2000},"successCriteria":{"type":"string","maxLength":500}},"required":["startUrl","successCriteria"],"additionalProperties":false},"files":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","minLength":1,"maxLength":128},"itemId":{"type":"string","minLength":1,"maxLength":128},"attachment":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":104857600}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false}},"required":["slot","attachment"],"additionalProperties":false}}},"required":["version","kind","job","features"],"additionalProperties":false}]},"ResearchDesignerPending2":{"type":"object","properties":{"brief":{"type":"string","maxLength":32000},"attachments":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":4194304}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false}},"request":{"type":"object","properties":{"operationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"profileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"contentLanguage":{"type":"string","enum":["en","fr","es","de","pt","ja","it","nl","sv","cs","pl","tr","ru","zh-Hans","ko","ar"]},"design":{"$ref":"#/components/schemas/ResearchRequestDesign2"}},"required":["operationId","profileId","design"],"additionalProperties":false}},"required":["brief","attachments","request"],"additionalProperties":false},"ResearchRequestDesign2":{"type":"object","properties":{"kind":{"description":"backtest when the study re-asks a decision the business already made, as its people faced it then. Omit it for any other study.","type":"string","const":"backtest"},"conversation":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","enum":["user","assistant"]},"content":{"type":"string","minLength":1,"maxLength":32000}},"required":["role","content"],"additionalProperties":false}},"attachments":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":4194304}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false}}},"required":["messages","attachments"],"additionalProperties":false},"name":{"type":"string","maxLength":120},"goal":{"type":"string","maxLength":10000},"summary":{"type":"string","maxLength":500},"questions":{"$ref":"#/components/schemas/ResearchQuestions4"},"assumptions":{"maxItems":10,"type":"array","items":{"type":"string","maxLength":10000},"description":"Customer assumptions: statements every respondent answers as true of themselves for this study only, beside their own profile, in order. Empty when the study states none."},"decision":{"description":"For a backtest only: its current decision question and what each option keeps. Omit it when there is none.","type":"object","properties":{"questionId":{"type":"string","minLength":1,"description":"The single-choice question that asks the decision."},"keeps":{"minItems":1,"maxItems":100,"type":"array","items":{"anyOf":[{"type":"number","minimum":0,"maximum":2},{"type":"null"}]},"description":"By option position: the share of usual buying the answer keeps (0 stops, 1 keeps, up to 2 buys more), or null to leave it out."}},"required":["questionId","keeps"],"additionalProperties":false},"authorEditedQuestions":{"description":"The questions in `questions` the author wrote or edited by hand since Alpha last delivered a study, which Alpha keeps as written unless the latest message asks to change them. Omit it when there are none.","maxItems":100,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"description":"The question's ID in `questions`."},"title":{"type":"string","maxLength":500,"description":"The question's title as the author left it."},"prompt":{"type":"string","maxLength":10000,"description":"The question's wording as the author left it."}},"required":["id","title","prompt"],"additionalProperties":false}}},"required":["conversation","name","goal","questions"],"additionalProperties":false},"ResearchQuestions4":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/ResearchItem3"}},"ResearchItem3":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128},"title":{"type":"string","maxLength":500},"prompt":{"type":"string","maxLength":10000},"flow":{"$ref":"#/components/schemas/ResearchFlow"},"attachment":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":4194304}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false},"stimulusItemId":{"type":"string","minLength":1,"maxLength":128},"blind":{"type":"boolean","const":true},"shape":{"type":"string","const":"open_ended"}},"required":["id","title","prompt","shape"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128},"title":{"type":"string","maxLength":500},"prompt":{"type":"string","maxLength":10000},"flow":{"$ref":"#/components/schemas/ResearchFlow"},"attachment":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":4194304}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false},"stimulusItemId":{"type":"string","minLength":1,"maxLength":128},"blind":{"type":"boolean","const":true},"shape":{"type":"string","enum":["closed_ended","multi_select","rank","matrix","scale"]},"options":{"maxItems":100,"type":"array","items":{"type":"string","maxLength":500}},"maxSelections":{"type":"integer","minimum":1,"maximum":100},"unaided":{"type":"boolean","const":true}},"required":["id","title","prompt","shape","options"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128},"title":{"type":"string","maxLength":500},"prompt":{"type":"string","maxLength":10000},"flow":{"$ref":"#/components/schemas/ResearchFlow"},"attachment":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":4194304}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false},"stimulusItemId":{"type":"string","minLength":1,"maxLength":128},"blind":{"type":"boolean","const":true},"shape":{"type":"string","const":"computer_task"},"targets":{"$ref":"#/components/schemas/ResearchTargets"},"successCriteria":{"type":"string","maxLength":10000}},"required":["id","title","prompt","shape","targets","successCriteria"],"additionalProperties":false}]},"ResearchDesignerProposalDesign2":{"type":"object","properties":{"message":{"type":"string","minLength":1,"maxLength":32000},"study":{"anyOf":[{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"goal":{"type":"string","maxLength":10000},"summary":{"type":"string","maxLength":500},"questions":{"minItems":1,"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/ResearchItem3"}},"assumptions":{"maxItems":10,"type":"array","items":{"type":"string","maxLength":10000},"description":"Customer assumptions: statements every respondent answers as true of themselves for this study only, beside their own profile, in order. Empty when the study states none."},"decision":{"description":"For a backtest only: the single-choice question that asks the decision and what each of its options keeps. Omit it for any other study.","type":"object","properties":{"questionId":{"type":"string","minLength":1,"description":"The single-choice question that asks the decision."},"keeps":{"minItems":1,"maxItems":100,"type":"array","items":{"anyOf":[{"type":"number","minimum":0,"maximum":2},{"type":"null"}]},"description":"By option position: the share of usual buying the answer keeps (0 stops, 1 keeps, up to 2 buys more), or null to leave it out."}},"required":["questionId","keeps"],"additionalProperties":false}},"required":["name","goal","summary","questions"],"additionalProperties":false},{"type":"null"}]}},"required":["message","study"],"additionalProperties":false},"ResearchMaterial3":{"oneOf":[{"type":"object","properties":{"version":{"type":"string","const":"research-stimulus.v1"},"title":{"type":"string","maxLength":500},"kind":{"type":"string","const":"copy"},"copies":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128},"label":{"type":"string","maxLength":500},"body":{"type":"string","maxLength":10000}},"required":["id","body"],"additionalProperties":false}}},"required":["version","kind","copies"],"additionalProperties":false},{"type":"object","properties":{"version":{"type":"string","const":"research-stimulus.v1"},"title":{"type":"string","maxLength":500},"kind":{"type":"string","const":"ads"},"format":{"type":"string","enum":["full_ad","headline","tagline","product_name","email_subject","social_post"]},"placement":{"type":"string","maxLength":120},"ads":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128},"headline":{"type":"string","maxLength":500},"body":{"type":"string","maxLength":10000},"callToAction":{"type":"string","maxLength":500},"landingUrl":{"type":"string","maxLength":2000},"intendedTakeaway":{"type":"string","maxLength":200}},"required":["id","headline"],"additionalProperties":false}},"files":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","minLength":1,"maxLength":128},"itemId":{"type":"string","minLength":1,"maxLength":128},"attachment":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":4194304}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false}},"required":["slot","attachment"],"additionalProperties":false}}},"required":["version","kind","ads"],"additionalProperties":false},{"type":"object","properties":{"version":{"type":"string","const":"research-stimulus.v1"},"title":{"type":"string","maxLength":500},"kind":{"type":"string","const":"concept"},"concepts":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128},"title":{"type":"string","maxLength":500},"description":{"type":"string","maxLength":10000},"assetRefs":{"maxItems":20,"type":"array","items":{"type":"string","maxLength":512}},"prototypeUrl":{"type":"string","maxLength":2000},"buyerGoal":{"type":"string","maxLength":120}},"required":["id","title","description"],"additionalProperties":false}},"files":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","minLength":1,"maxLength":128},"itemId":{"type":"string","minLength":1,"maxLength":128},"attachment":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":4194304}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false}},"required":["slot","attachment"],"additionalProperties":false}}},"required":["version","kind","concepts"],"additionalProperties":false},{"type":"object","properties":{"version":{"type":"string","const":"research-stimulus.v1"},"title":{"type":"string","maxLength":500},"kind":{"type":"string","const":"offer_set"},"offers":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128},"title":{"type":"string","maxLength":500},"description":{"type":"string","maxLength":10000},"terms":{"type":"string","maxLength":5000}},"required":["id","title","description"],"additionalProperties":false}},"category":{"type":"string","maxLength":200},"liveOffer":{"type":"object","properties":{"offerId":{"type":"string","maxLength":128},"url":{"type":"string","maxLength":2048}},"required":["offerId","url"],"additionalProperties":false},"files":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","minLength":1,"maxLength":128},"itemId":{"type":"string","minLength":1,"maxLength":128},"attachment":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":4194304}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false}},"required":["slot","attachment"],"additionalProperties":false}}},"required":["version","kind","offers"],"additionalProperties":false},{"type":"object","properties":{"version":{"type":"string","const":"research-stimulus.v1"},"title":{"type":"string","maxLength":500},"kind":{"type":"string","const":"price_ladder"},"description":{"type":"string","maxLength":10000},"currency":{"type":"string","maxLength":10},"billingUnit":{"type":"string","enum":["one_time","per_month","per_year","per_seat_per_month"]},"prices":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128},"amount":{"type":"string","maxLength":100},"label":{"type":"string","maxLength":500}},"required":["id","amount"],"additionalProperties":false}},"plannedPriceId":{"type":"string","minLength":1,"maxLength":128},"category":{"type":"string","maxLength":200},"alternatives":{"maxItems":3,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128},"name":{"type":"string","maxLength":60},"amount":{"type":"string","maxLength":100}},"required":["id","name","amount"],"additionalProperties":false}},"plans":{"maxItems":4,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128},"name":{"type":"string","maxLength":60}},"required":["id","name"],"additionalProperties":false}},"pricingPageUrl":{"type":"string","maxLength":2048},"files":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","minLength":1,"maxLength":128},"itemId":{"type":"string","minLength":1,"maxLength":128},"attachment":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":4194304}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false}},"required":["slot","attachment"],"additionalProperties":false}}},"required":["version","title","kind","currency","prices"],"additionalProperties":false},{"type":"object","properties":{"version":{"type":"string","const":"research-stimulus.v1"},"title":{"type":"string","maxLength":500},"kind":{"type":"string","const":"task"},"instructions":{"type":"string","maxLength":10000},"destinationUrl":{"type":"string","maxLength":2048},"problem":{"type":"string","maxLength":120},"keyMessage":{"type":"string","maxLength":200},"files":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","minLength":1,"maxLength":128},"itemId":{"type":"string","minLength":1,"maxLength":128},"attachment":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":4194304}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false}},"required":["slot","attachment"],"additionalProperties":false}}},"required":["version","title","kind","instructions"],"additionalProperties":false},{"type":"object","properties":{"version":{"type":"string","const":"research-stimulus.v1"},"title":{"type":"string","maxLength":500},"kind":{"type":"string","const":"custom"},"content":{"type":"string","maxLength":10000},"assetRefs":{"maxItems":20,"type":"array","items":{"type":"string","maxLength":512}}},"required":["version","kind","content"],"additionalProperties":false},{"type":"object","properties":{"version":{"type":"string","const":"research-stimulus.v1"},"title":{"type":"string","maxLength":500},"kind":{"type":"string","const":"brand"},"brand":{"type":"string","maxLength":500},"category":{"type":"string","maxLength":200},"competitors":{"maxItems":5,"type":"array","items":{"type":"string","maxLength":500}},"startUrl":{"type":"string","maxLength":2048}},"required":["version","kind","category","competitors"],"additionalProperties":false},{"type":"object","properties":{"version":{"type":"string","const":"research-stimulus.v1"},"title":{"type":"string","maxLength":500},"kind":{"type":"string","const":"features"},"job":{"type":"string","maxLength":200},"productName":{"type":"string","maxLength":200},"features":{"maxItems":15,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128},"name":{"type":"string","maxLength":60},"description":{"type":"string","maxLength":160}},"required":["id","name","description"],"additionalProperties":false}},"productTask":{"type":"object","properties":{"startUrl":{"type":"string","maxLength":2000},"successCriteria":{"type":"string","maxLength":500}},"required":["startUrl","successCriteria"],"additionalProperties":false},"files":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","minLength":1,"maxLength":128},"itemId":{"type":"string","minLength":1,"maxLength":128},"attachment":{"type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":4194304}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false}},"required":["slot","attachment"],"additionalProperties":false}}},"required":["version","kind","job","features"],"additionalProperties":false}]},"ResearchEntry":{"anyOf":[{"$ref":"#/components/schemas/ResearchEntryVariant"},{"type":"null"}],"description":"The run's campaign entry (its id is the run's): its interviews by state and its outcome, as campaigns.campaign-entries.get.v2 reads it; null before any run."},"ResearchEntryVariant":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"sequence":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"The entry's ordinal among its campaign's entries, from 1."},"failureReason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The code the entry settled with when it failed or was cancelled (for example no_unit_delivered or no_eligible_customers); null otherwise, or when it recorded no code."},"progress":{"$ref":"#/components/schemas/ResearchProgress"}},"required":["id","sequence","failureReason","progress"],"additionalProperties":false},"ResearchProgress":{"type":"object","properties":{"unitLabel":{"type":"string","enum":["visit","interview","conversation"],"description":"What one unit of this entry's work is: an Experience visit, a Research interview, a Discovery conversation."},"admission":{"type":"string","enum":["entry","unit"],"description":"`entry`: the entry's work is admitted and billed once; `unit`: each unit is."},"counts":{"type":"object","properties":{"admitted":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Units admitted to run."},"delivered":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Settled units the product counts as delivered."},"failed":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Units that ended without delivering: counted as each one ends where the entry's work is admitted once, and when a unit's own admission settles where each unit is."},"open":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Units that have not ended yet."}},"required":["admitted","delivered","failed","open"],"additionalProperties":false},"outcome":{"type":"string","enum":["running","succeeded","failed","cancelled","partial"],"description":"Running until the entry settles; failed or cancelled when its product settled it so (a failed final result still counts the units it delivered); otherwise counted from the units: succeeded when every admitted unit delivered, partial when some did, failed when none did. An entry its product settled succeeded whose units no longer exist (all counts 0) stays succeeded."},"failureReasons":{"type":"array","items":{"type":"object","properties":{"reason":{"type":"string"},"count":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["reason","count"],"additionalProperties":false},"description":"Why the failed units failed, one row per reason with how many units it ended. A unit that failed while its admission still runs has no reason until that settles."}},"required":["unitLabel","admission","counts","outcome","failureReasons"],"additionalProperties":false,"description":"The entry's units, counted from its product's delivered evidence."},"ResearchRange":{"anyOf":[{"$ref":"#/components/schemas/ResearchRangeVariant"},{"type":"null"}],"description":"The date range the figures are read over: every interview completed on its days. Null on a saved run's results, before the first interview, and when the range holds no interview."},"ResearchRangeVariant":{"type":"object","properties":{"from":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"The range's first UTC day, never before the campaign's first interview."},"to":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"The range's last UTC day, never past today."},"interactionCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The interviews completed on the range's days, under the scope."},"customerCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The distinct customers of those interviews."}},"required":["from","to","interactionCount","customerCount"],"additionalProperties":false},"ResearchRows":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"gate"},"title":{"type":"string"},"base":{"type":"string","description":"The respondents counted, as `n = …`."}},"required":["kind","title","base"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"question"},"id":{"type":"string","description":"The question id."},"badge":{"type":"string"},"title":{"type":"string"},"question":{"type":"string"},"shape":{"description":"The question's authored type; absent when it has left the instrument.","type":"string","enum":["open_ended","closed_ended","multi_select","rank","matrix","scale","computer_task"]},"attachment":{"description":"The file the question introduced to respondents; absent when it introduced none.","type":"object","properties":{"artifactId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf","text/plain","text/markdown","text/csv","video/mp4","video/webm","audio/mpeg","audio/wav"]},"byteLength":{"type":"integer","exclusiveMinimum":0,"maximum":104857600}},"required":["artifactId","filename","mediaType","byteLength"],"additionalProperties":false},"average":{"description":"A scale's or matrix's mean rating on its authored range.","type":"object","properties":{"value":{"type":"number"},"max":{"type":"number"}},"required":["value","max"],"additionalProperties":false},"summary":{"description":"The shown run's synthesized summary, campaign-wide; absent when it has none.","type":"string"},"analysisCoverage":{"type":"object","properties":{"aggregateResponses":{"type":"integer","minimum":0,"maximum":9007199254740991},"summaryResponses":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["aggregateResponses","summaryResponses"],"additionalProperties":false},"evidence":{"description":"The shown run's synthesized evidence quotes, campaign-wide.","type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"quote":{"type":"string"}},"required":["label","quote"],"additionalProperties":false}},"primary":{"description":"The figure the card leads with; absent unanswered.","type":"object","properties":{"label":{"type":"string"},"value":{"type":"number","description":"A whole percent, 0 to 100."},"tone":{"type":"string","enum":["positive","neutral","negative"]},"averageRank":{"description":"A ranked option's mean position, 1 = first; ranking questions only.","type":"number"},"optionIndex":{"description":"The option's place among the question's authored options, 0 = first; counted choice and ranking figures only.","type":"integer","minimum":0,"maximum":9007199254740991}},"required":["label","value","tone"],"additionalProperties":false},"slices":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"number","description":"A whole percent, 0 to 100."},"tone":{"type":"string","enum":["positive","neutral","negative"]},"averageRank":{"description":"A ranked option's mean position, 1 = first; ranking questions only.","type":"number"},"optionIndex":{"description":"The option's place among the question's authored options, 0 = first; counted choice and ranking figures only.","type":"integer","minimum":0,"maximum":9007199254740991}},"required":["label","value","tone"],"additionalProperties":false}},"detailTitle":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string","description":"The detail's figure as the dashboard reads it."},"tone":{"type":"string","enum":["positive","neutral","negative"]}},"required":["label","value","tone"],"additionalProperties":false}},"sampleCount":{"description":"The accepted answers the figure counted: on every range's results, and on a saved run's under a segment.","type":"integer","minimum":0,"maximum":9007199254740991},"headline":{"$ref":"#/components/schemas/ResearchHeadline"}},"required":["kind","id","badge","title","question","slices"],"additionalProperties":false}]}},"ResearchHeadline":{"description":"The figure the card leads with over the date range and the respondents it stands on; absent on a saved run's results and where the range counts no answer to it.","type":"object","properties":{"label":{"type":"string","description":"What the figure measures, as the card names it."},"unit":{"type":"string","enum":["percent","average"],"description":"A whole percent, or an average on the scale's authored range."},"basis":{"type":"string","enum":["share","derived"],"description":"share: one share of its respondents, whose margin is stated; derived: an average or a score, whose precision reads its respondents alone."},"max":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The scale's top value for an average; null for a percent."},"value":{"type":"number","description":"The figure over the date range."},"n":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The accepted answers that value counts."},"customers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct respondents behind those answers: the sample the figure stands on."}},"required":["label","unit","basis","max","value","n","customers"],"additionalProperties":false},"ResearchScorecard":{"anyOf":[{"type":"object","properties":{"title":{"type":"string"},"lead":{"anyOf":[{"type":"object","properties":{"text":{"type":"string"},"subject":{"type":"string"}},"required":["text"],"additionalProperties":false},{"type":"null"}],"description":"One sentence naming the decision; null without one."},"tables":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"rowLabel":{"type":"string"},"columns":{"type":"array","items":{"type":"string"}},"rows":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"},"cells":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"share"},"percent":{"type":"number"},"base":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["kind","percent","base"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"average"},"value":{"type":"number"},"base":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["kind","value","base"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"index"},"value":{"type":"number"}},"required":["kind","value"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"text"},"text":{"type":"string"}},"required":["kind","text"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"none"}},"required":["kind"],"additionalProperties":false,"description":"Nobody in the scope answered."},{"type":"object","properties":{"kind":{"type":"string","const":"not_applicable"}},"required":["kind"],"additionalProperties":false,"description":"What the cell reads does not exist for its row."}]},"description":"One cell per column."}},"required":["key","label","cells"],"additionalProperties":false}}},"required":["rowLabel","columns","rows"],"additionalProperties":false}}},"required":["title","lead","tables"],"additionalProperties":false},{"type":"null"}]},"ResearchPrecision":{"anyOf":[{"type":"object","properties":{"basis":{"type":"string","enum":["share","derived"]},"span":{"type":"string","enum":["window","range"]},"customers":{"type":"integer","minimum":0,"maximum":9007199254740991},"marginOfErrorPts":{"type":"number"},"level":{"type":"string","enum":["low","standard"]},"change":{"anyOf":[{"type":"object","properties":{"points":{"type":"number"},"comparedTo":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"significant":{"type":"boolean"},"instrumentChanged":{"type":"boolean","const":true}},"required":["points","comparedTo","significant"],"additionalProperties":false},{"type":"null"}]}},"required":["basis","span","customers","marginOfErrorPts","level","change"],"additionalProperties":false,"description":"The figure's precision over the date range's distinct respondents behind it (a mean: its verdict from its respondents alone)."},{"type":"null"}],"description":"Over a date range's respondents; null on a saved run's results, which are no range's."},"ResearchInterpretation":{"anyOf":[{"type":"object","properties":{"brand":{"type":"object","properties":{"value":{"type":"string"},"basis":{"type":"string","enum":["customer_fact","caller_fact","creative_claim","explicit_assumption","unknown"]}},"required":["value","basis"],"additionalProperties":false},"category":{"type":"object","properties":{"value":{"type":"string"},"basis":{"type":"string","enum":["customer_fact","caller_fact","creative_claim","explicit_assumption","unknown"]}},"required":["value","basis"],"additionalProperties":false},"offering":{"type":"object","properties":{"value":{"type":"string"},"basis":{"type":"string","enum":["customer_fact","caller_fact","creative_claim","explicit_assumption","unknown"]}},"required":["value","basis"],"additionalProperties":false},"intendedAudience":{"type":"object","properties":{"value":{"type":"string"},"basis":{"type":"string","enum":["customer_fact","caller_fact","creative_claim","explicit_assumption","unknown"]}},"required":["value","basis"],"additionalProperties":false},"claims":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"basis":{"type":"string","enum":["customer_fact","caller_fact","creative_claim","explicit_assumption","unknown"]}},"required":["value","basis"],"additionalProperties":false}},"uncertainties":{"type":"array","items":{"type":"string"}}},"required":["brand","category","offering","intendedAudience","claims","uncertainties"],"additionalProperties":false},{"type":"null"}]},"ResearchDesign2":{"anyOf":[{"$ref":"#/components/schemas/ResearchProposalDesign"},{"type":"null"}],"description":"Alpha's reply and the study when ready; null while pending or after a failure."},"ResearchDesign3":{"anyOf":[{"$ref":"#/components/schemas/ResearchDesignerProposalDesign"},{"type":"null"}],"description":"Alpha's reply and the study when ready; null while pending or after a failure."},"ResearchDesign4":{"anyOf":[{"$ref":"#/components/schemas/ResearchDesignerProposalDesign2"},{"type":"null"}],"description":"Alpha's reply and the study when ready; null while pending or after a failure."},"ResearchStoryboard":{"anyOf":[{"type":"object","properties":{"status":{"type":"string","enum":["preparing","ready","refused","failed"],"description":"preparing while the frames and transcript are made; ready once they exist; refused when the file cannot be used (see refusalCode); failed when preparation could not finish. Replace a refused or failed video by uploading it again."},"refusalCode":{"anyOf":[{"type":"string","enum":["unsupported_container","unsupported_video_codec","unsupported_audio_codec","no_video_stream","too_long","undecodable"]},{"type":"null"}],"description":"Why a refused video cannot be used; null otherwise."},"durationMs":{"anyOf":[{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},{"type":"null"}]},"modelByteLength":{"anyOf":[{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},{"type":"null"}],"description":"What a ready video counts toward a study's attachment bound: its frames and transcript, never the video file."},"frames":{"maxItems":12,"type":"array","items":{"type":"object","properties":{"atMs":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"When in the video this frame was taken."},"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Read the picture with research.study-attachments.download.v1."},"width":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"height":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["atMs","artifactId","width","height"],"additionalProperties":false}},"transcript":{"anyOf":[{"type":"object","properties":{"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"segments":{"type":"array","items":{"type":"object","properties":{"startMs":{"type":"integer","minimum":0,"maximum":9007199254740991},"endMs":{"type":"integer","minimum":0,"maximum":9007199254740991},"text":{"type":"string"}},"required":["startMs","endMs","text"],"additionalProperties":false}}},"required":["language","segments"],"additionalProperties":false},{"type":"null"}],"description":"What was said, in timed segments; no segments for a silent video."}},"required":["status","refusalCode","durationMs","modelByteLength","frames","transcript"],"additionalProperties":false},{"type":"null"}],"description":"A video's storyboard; null for every other file."},"ExperienceFollows":{"description":"Instead of customerIds, follow a Discovery campaign for a share of its customers, as Bootup's Experience takes them: at the launch, of the customers on its roster the launch admits, in the order Discovery sampled them, the first 1 in sampleEvery (rounded up) at each of its stores, at most 100 dealt one per store. The campaign records the follow, and each later scheduled cycle re-reads that roster: a customer who left it leaves, each store the campaign's customers no longer cover lends its share up to 100, a customer still on it stays, and a Save changes no customers; while the followed campaign is archived the customers stay as they are and a restore resumes the follow at the next scheduled cycle, and once it is deleted they stay for good. A Forecast campaign lends its Forecast's customers. To shop each customer's direct competitors too, competitorSourceCampaignId names this same campaign.","type":"object","properties":{"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"A Discovery campaign on the same business profile (discovery_campaigns_list_v1's businessProfileId), active or paused, with a finished round."},"sampleEvery":{"type":"integer","minimum":1,"maximum":20,"description":"1 in how many of its customers shop: 1 is every customer, at most 1 in 20."}},"required":["campaignId","sampleEvery"],"additionalProperties":false},"ExperienceLocationContexts":{"description":"Instead of customerIds or follows, and beside locationKeys, stores picked on Google Maps whose customers visit: each one store, one address (the finder's pick carries its googlePlace). A pick the business profile already has as a store with customers is that store; any other is set up first as a Discovery campaign sets up a store: verified on Google Maps, researched as a store and given 97 customers, which the prescreen counts and which are included in the plan at no charge; the launch then shops its share of every store's customers. 100 stores at most with locationKeys. New stores that together would generate more than 5000 customers, the most one Discovery settings Save generates, refuse the launch (INVALID_INPUT), and so does a store Google Maps cannot place (LOCATION_UNMAPPABLE).","minItems":1,"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/DiscoveryLocationContextsItem"}},"ExperienceLatestEntry":{"anyOf":[{"$ref":"#/components/schemas/ResearchEntryVariant"},{"type":"null"}],"description":"The campaign's latest entry (its launch, scheduled firing, run now or an edit's rerun; its id is its cycle's) with its visits counted; null before its first. Read it in full with campaigns.campaign-entries.get.v2."},"ExperienceCampaign":{"type":"object","properties":{"id":{"type":"string"},"key":{"type":"string"},"name":{"type":"string"},"mode":{"type":"string","enum":["pulse","burst"]},"status":{"type":"string","enum":["active","paused","archived","deleted"]},"objective":{"anyOf":[{"type":"string"},{"type":"null"}]},"profileUrl":{"type":"string"},"sourceDiscoveryCampaignName":{"anyOf":[{"type":"string"},{"type":"null"}]},"locationCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"pulseSampleEvery":{"anyOf":[{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"agents":{"type":"array","items":{"type":"string","enum":["point11","dots","spark","muse","grok_bot"]},"description":"The agents the campaign's cycles shop with from now, in product order: the segment scope's agent options (experience_campaign_segments_get's agents). point11 is Point11's own shopper; every other is simulated: the model its vendor's consumer agent runs, in Point11's browser"}},"required":["id","key","name","mode","status","objective","profileUrl","sourceDiscoveryCampaignName","locationCount","pulseSampleEvery","createdAt","agents"],"additionalProperties":false},"ExperienceDateScope":{"type":"object","properties":{"window":{"anyOf":[{"type":"object","properties":{"from":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"to":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["from","to"],"additionalProperties":false},{"type":"null"}],"description":"The window the figures actually cover; null is all time"},"widenedToAllTime":{"type":"boolean"},"availableDateRange":{"anyOf":[{"type":"object","properties":{"from":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"to":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"}},"required":["from","to"],"additionalProperties":false},{"type":"null"}],"description":"The days of the campaign's first and last interaction under the segment scope; null before its first"},"outOfRange":{"anyOf":[{"type":"object","properties":{"firstDay":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"lastDay":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"}},"required":["firstDay","lastDay"],"additionalProperties":false},{"type":"null"}],"description":"Set when the requested window holds none of the campaign's interactions: the days of its first and last"}},"required":["window","widenedToAllTime","availableDateRange","outOfRange"],"additionalProperties":false},"ExperienceResults":{"anyOf":[{"type":"object","properties":{"from":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"The first UTC day a trend plots: the range's, never before the first interaction."},"to":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"The last UTC day a trend plots: the range's end, never past today."},"asOf":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"The UTC day every single value is as of: its value is the average over the campaign's interactions dated in the 30 days ending with it. The range's end, or, when those 30 days hold none, the last day with an interaction."},"comparedTo":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"The day a change compares with: 30 days before asOf."},"interactionCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The interactions dated in the 30 days ending asOf, under the scope."},"customerCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The distinct customers of those interactions."},"campaignCustomerCount":{"description":"Under a segment scope: the whole campaign's distinct customers in the same 30 days on the same website, unscoped (customers a precision order added for a group count only in that group's readings). Absent when the read is unscoped, whose customerCount is the campaign's.","type":"integer","minimum":0,"maximum":9007199254740991},"bucketCustomerCount":{"description":"Under a scope that names a customer bucket (an attribute or a store): the distinct customers inside it in the same 30 days. Absent without one.","type":"integer","minimum":0,"maximum":9007199254740991}},"required":["from","to","asOf","comparedTo","interactionCount","customerCount"],"additionalProperties":false},{"type":"null"}],"description":"Every figure is over the campaign's interactions dated in the 30 UTC days ending with its day: a single figure as of asOf, a line one point per day from `from` to `to`. Null when the campaign has no interaction on or before the range's end under the scope"},"ExperienceCompetition":{"type":"object","properties":{"ownWebsite":{"type":"boolean","description":"The campaign has one website of its own to set against competitors: its measured site, else its one page. False for a campaign of several pages and no measured site, which states no gap and no dollars"},"shopsCompetitors":{"type":"boolean","description":"Discovery named a competitor for the campaign, ready to shop or not. False for a campaign that shops its own website alone, which has nothing to be valued against and no Brands map to draw"},"readsDiscovery":{"type":"boolean","description":"The campaign names a Discovery campaign the organization still holds, the one its competitors and how often AI picks each brand are read from. False when it names none or the one it named is gone, so the Matrix map has nothing to plot"}},"required":["ownWebsite","shopsCompetitors","readsDiscovery"],"additionalProperties":false,"description":"What every read against competitors stands on, so a reader can say why revenueValue is null, or why a campaign has no Brands map or Matrix to draw"},"ExperienceData":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"runId":{"type":"string"},"inProgress":{"type":"boolean"},"executionStatus":{"anyOf":[{"type":"string","enum":["scheduled","waiting","running","completed","failed","cancelled"]},{"type":"null"}]},"visitIdentity":{"anyOf":[{"type":"object","properties":{"key":{"type":"string"},"scenarioId":{"anyOf":[{"type":"string"},{"type":"null"}]},"cycleId":{"anyOf":[{"type":"string"},{"type":"null"}]},"cycleCreatedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"repetition":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["key","scenarioId","cycleId","cycleCreatedAt","repetition"],"additionalProperties":false},{"type":"null"}]},"evidenceDisposition":{"anyOf":[{"type":"string","enum":["sufficient","insufficient","policy_limited","infrastructure_limited","scenario_mismatch"]},{"type":"null"}]},"customerId":{"type":"string"},"customerName":{"type":"string"},"customerJobTitle":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The customer's job title as the visit's scenario froze it; null when it named none"},"destinationName":{"type":"string"},"destinationFingerprint":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The website's id (experience_campaigns_get_v3's destinations[].id, which destinationFingerprint filters by); null for a visit no campaign website holds"},"browserDevice":{"type":"string","enum":["desktop","mobile","ios_safari"]},"agent":{"type":"string","enum":["point11","dots","spark","muse","grok_bot"],"description":"The agent that shopped the visit; point11 (Point11's own shopper) for a visit no campaign planned. Another agent's visit of the same customer, website and device is another row (visitIdentity.key ends in :<agent>)"},"nativeApp":{"anyOf":[{"type":"object","properties":{"platform":{"type":"string","enum":["ios","android"]},"buildId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$"},"appId":{"type":"string","minLength":1,"maxLength":255},"versionLabel":{"type":"string","minLength":1,"maxLength":120},"deviceName":{"type":"string","minLength":1,"maxLength":120},"osVersion":{"type":"string","minLength":1,"maxLength":80}},"required":["platform","buildId","sha256","appId","versionLabel","deviceName","osVersion"],"additionalProperties":false},{"type":"null"}]},"unavailableReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"achieved":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"qualityStars":{"anyOf":[{"type":"number"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"actionCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"durationMs":{"anyOf":[{"type":"number"},{"type":"null"}]},"frictionSteps":{"anyOf":[{"type":"array","items":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},{"type":"null"}]},"recording":{"type":"object","properties":{"thumbnailArtifactId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The journey's stored small thumbnail: its first captured screen as a WebP sized for a list row (kind small_thumbnail), downloaded with experience_run_artifacts_download_v3; a journey recorded before small thumbnails existed names its thumbnail (kind thumbnail) until its small one is stored; null until either is stored"},"durationMs":{"anyOf":[{"type":"number"},{"type":"null"}]},"stages":{"type":"array","items":{"type":"object","properties":{"stepNumber":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"tone":{"anyOf":[{"type":"string","enum":["progress","friction","uncertain","failed"]},{"type":"null"}]},"label":{"type":"string"}},"required":["stepNumber","tone","label"],"additionalProperties":false}}},"required":["thumbnailArtifactId","durationMs","stages"],"additionalProperties":false}},"required":["runId","inProgress","executionStatus","visitIdentity","evidenceDisposition","customerId","customerName","customerJobTitle","destinationName","destinationFingerprint","browserDevice","agent","nativeApp","unavailableReason","achieved","qualityStars","completedAt","actionCount","durationMs","frictionSteps","recording"],"additionalProperties":false}},"ExperienceChanges":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","description":"The UTC day from which the changed instrument measured"},"kind":{"type":"string","enum":["scorer","shopper","models","browser"],"description":"scorer: the scoring call's prompt, task or answer schema version moved; shopper: the shopper's Computer Use call's prompt or task version moved; models: the frozen model plan the visits ran under changed, between cycles or re-frozen mid-cycle; browser: the browser conditions one website's visits on one device were frozen under changed (emulation, frame, automation waits, certificate, ad and CAPTCHA settings, connection access). Each marks every figure of the read, whichever website it was measured on"},"version":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The call versions measured from day, joined by ' · ': a scorer's prompt, task and answer schema versions, a shopper's prompt and task versions; null for a models or browser change"},"agents":{"type":"array","items":{"type":"string","enum":["point11","dots","spark","muse","grok_bot"]},"description":"The agents whose visits it measured differently, in product order: each agent's visits are a series of their own (its models are its own shopper call's and the shared ones, never another agent's), so a repin of one agent's model names that agent alone, and a read of every agent names each agent's changes"}},"required":["day","kind","version","agents"],"additionalProperties":false},"description":"Each instrument change among the interactions the figures read, oldest first"},"ExperienceCustomerLocations":{"type":"array","items":{"type":"object","properties":{"customerId":{"type":"string"},"addressDetail":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/JsonValue"}},{"type":"null"}]},"countryCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"subdivisionCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"location":{"type":"object","properties":{"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"countryCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"admin1":{"anyOf":[{"type":"string"},{"type":"null"}]},"admin1Code":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"street":{"anyOf":[{"type":"string"},{"type":"null"}]},"postcode":{"anyOf":[{"type":"string"},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"coordinateSource":{"anyOf":[{"type":"string","enum":["source","derived_descendants","unavailable","street_address"]},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["country","countryCode","admin1","admin1Code","city","street","postcode","latitude","longitude","coordinateSource","label"],"additionalProperties":false},"journeyCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"finishedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"scoredCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"judgedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"passedCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["customerId","addressDetail","countryCode","subdivisionCode","location","journeyCount","finishedCount","scoredCount","judgedCount","passedCount"],"additionalProperties":false}},"ExperienceReplayJourneys":{"type":"array","items":{"type":"object","properties":{"runId":{"type":"string"},"inProgress":{"type":"boolean"},"executionStatus":{"anyOf":[{"type":"string","enum":["scheduled","waiting","running","completed","failed","cancelled"]},{"type":"null"}]},"customerId":{"type":"string"},"customerName":{"type":"string"},"customerJobTitle":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The customer's job title as the visit's scenario froze it; null when it named none"},"destinationName":{"type":"string"},"destinationFingerprint":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The website's id (experience_campaigns_get_v3's destinations[].id, which destinationFingerprint filters by); null for a visit no campaign website holds"},"browserDevice":{"type":"string","enum":["desktop","mobile","ios_safari"]},"agent":{"type":"string","enum":["point11","dots","spark","muse","grok_bot"],"description":"The agent that shopped the visit; point11 (Point11's own shopper) for a visit no campaign planned. Another agent's visit of the same customer, website and device is another row (visitIdentity.key ends in :<agent>)"},"nativeApp":{"anyOf":[{"type":"object","properties":{"platform":{"type":"string","enum":["ios","android"]},"buildId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$"},"appId":{"type":"string","minLength":1,"maxLength":255},"versionLabel":{"type":"string","minLength":1,"maxLength":120},"deviceName":{"type":"string","minLength":1,"maxLength":120},"osVersion":{"type":"string","minLength":1,"maxLength":80}},"required":["platform","buildId","sha256","appId","versionLabel","deviceName","osVersion"],"additionalProperties":false},{"type":"null"}]},"unavailableReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"achieved":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"qualityStars":{"anyOf":[{"type":"number"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"actionCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"durationMs":{"anyOf":[{"type":"number"},{"type":"null"}]},"evidenceDisposition":{"type":"string","enum":["sufficient","insufficient","policy_limited","infrastructure_limited","scenario_mismatch"]},"recording":{"type":"object","properties":{"thumbnailArtifactId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The journey's stored thumbnail: its first captured screen as a WebP sized for the overview's replay card (kind thumbnail), downloaded with experience_run_artifacts_download_v3; null until it is stored"},"recorded":{"type":"boolean","description":"Whether the journey captured any screen: one that did and has no thumbnail yet still has a recording to watch"}},"required":["thumbnailArtifactId","recorded"],"additionalProperties":false}},"required":["runId","inProgress","executionStatus","customerId","customerName","customerJobTitle","destinationName","destinationFingerprint","browserDevice","agent","nativeApp","unavailableReason","achieved","qualityStars","completedAt","actionCount","durationMs","recording"],"additionalProperties":false}},"ExperienceRevenueValue":{"type":"object","properties":{"foundPairs":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Every matched pair there is, whether or not both sides have an Experience Score yet: matchedPairs plus the pairs of the comparisons a side has no score on"},"matchedPairs":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Matched pairs: one journey on the campaign's website with the same customer's journey on one competitor's, so a customer who shopped three competitors is three pairs. Counted over the comparisons with an Experience Score on both sides"},"ourMatchedScore":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The campaign's own website's Experience Score over the matched pairs alone, 0 to 100, each competitor weighted by its matched pairs"},"competitorScore":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The competitors' Experience Score over the same pairs, each weighted by its matched pairs"},"gapPts":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"ourMatchedScore less competitorScore, in points"},"customers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct customers behind the pairs found: the sample the gap's precision reads (98/√n points, Standard at ±5.0 or tighter: 385 customers)"},"experienceUsd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Experience dollars, plus or minus against the competitors: the lines' experienceUsd added up, each line valued apart; null when no line has any. They are over the lines with economics, while gapPts beside them is over every comparison, so the two do not multiply into each other"},"valuedLines":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"How many of lines have experienceUsd"},"valuedCustomers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct customers behind the pairs of the revenue lines with economics, each once however many of those lines its scenarios froze: the sample the dollars' precision reads; 0 without dollars"},"passRate":{"type":"object","properties":{"oursPct":{"anyOf":[{"type":"number"},{"type":"null"}]},"theirsPct":{"anyOf":[{"type":"number"},{"type":"null"}]},"gapPts":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"oursPct less theirsPct, in points"}},"required":["oursPct","theirsPct","gapPts"],"additionalProperties":false,"description":"The site pass rate over the matched pairs, 0 to 100, ours and the competitors'"},"averageStars":{"type":"object","properties":{"ours":{"anyOf":[{"type":"number"},{"type":"null"}]},"theirs":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["ours","theirs"],"additionalProperties":false,"description":"Mean stars over the rated journeys of the matched pairs, ours and the competitors'"},"lines":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The product's id: its revenue line id"},"label":{"type":"string"},"assigned":{"type":"boolean","description":"False for the journeys whose scenario names no product (revenue line): they count in every gap and have no economics and no dollars"},"economics":{"anyOf":[{"type":"object","properties":{"annualSalesUsd":{"type":"number"},"aiInfluencePct":{"type":"number"},"serviceableAvailableMarketUsd":{"type":"number","description":"SAM: annual sales ÷ market share"},"aiInfluencedSalesUsd":{"type":"number","description":"Annual sales × AI influence: the brand's own sales AI assistants influence"},"aiInfluencedMarketUsd":{"type":"number","description":"SAM × AI influence, a year: one point of the gap is a hundredth of it"}},"required":["annualSalesUsd","aiInfluencePct","serviceableAvailableMarketUsd","aiInfluencedSalesUsd","aiInfluencedMarketUsd"],"additionalProperties":false},{"type":"null"}],"description":"The line's market assumptions in Tools › Products today where the product lives, as business.revenue-lines.list values them: at company scope, else its locations' added up; null without complete assumptions"},"point":{"anyOf":[{"type":"object","properties":{"pointValueUsd":{"type":"number","description":"One point of the line's gap, in dollars"},"basis":{"type":"string","enum":["ceiling"],"description":"Always ceiling: a point is aiInfluencedMarketUsd ÷ 100, whatever the score"}},"required":["pointValueUsd","basis"],"additionalProperties":false},{"type":"null"}],"description":"What one point of Experience Score gap is worth on the line, aiInfluencedMarketUsd ÷ 100; null without economics or a matched score"},"foundPairs":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Every matched pair there is, whether or not both sides have an Experience Score yet: matchedPairs plus the pairs of the comparisons a side has no score on"},"matchedPairs":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Matched pairs: one journey on the campaign's website with the same customer's journey on one competitor's, so a customer who shopped three competitors is three pairs. Counted over the comparisons with an Experience Score on both sides"},"ourMatchedScore":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The campaign's own website's Experience Score over the matched pairs alone, 0 to 100, each competitor weighted by its matched pairs"},"competitorScore":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The competitors' Experience Score over the same pairs, each weighted by its matched pairs"},"gapPts":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"ourMatchedScore less competitorScore, in points"},"customers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct customers behind the pairs found: the sample the gap's precision reads (98/√n points, Standard at ±5.0 or tighter: 385 customers)"},"experienceUsd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"point.pointValueUsd × gapPts, plus or minus; null without a point or a gap"},"competitors":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The competitor's website id, as destinations[].id names it"},"foundPairs":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Every matched pair there is, whether or not both sides have an Experience Score yet: matchedPairs plus the pairs of the comparisons a side has no score on"},"matchedPairs":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Matched pairs: one journey on the campaign's website with the same customer's journey on one competitor's, so a customer who shopped three competitors is three pairs. Counted over the comparisons with an Experience Score on both sides"},"ourMatchedScore":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The campaign's own website's Experience Score over the matched pairs alone, 0 to 100, each competitor weighted by its matched pairs"},"competitorScore":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The competitors' Experience Score over the same pairs, each weighted by its matched pairs"},"gapPts":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"ourMatchedScore less competitorScore, in points"},"customers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct customers behind the pairs found: the sample the gap's precision reads (98/√n points, Standard at ±5.0 or tighter: 385 customers)"},"experienceUsd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"This competitor's part of the line's dollars: the line's point by its share of the line's matched pairs, × its gap. A line's parts add up to the line, to the cent"}},"required":["id","foundPairs","matchedPairs","ourMatchedScore","competitorScore","gapPts","customers","experienceUsd"],"additionalProperties":false},"description":"The line against each competitor, most pairs found first"}},"required":["id","label","assigned","economics","point","foundPairs","matchedPairs","ourMatchedScore","competitorScore","gapPts","customers","experienceUsd","competitors"],"additionalProperties":false},"description":"Every product (revenue line) with a matched pair, most AI-influenced sales first; the journeys of no product are one of them, with assigned false"},"competitors":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"experienceUsd":{"anyOf":[{"type":"number"},{"type":"null"}]},"valuedPairs":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The competitor's matched pairs on the lines its experienceUsd is parts of: the pairs its dollars stand on, none of a line without economics; 0 without dollars"},"valuedCustomers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct customers behind the competitor's pairs on the revenue lines with economics, each once; 0 without dollars"}},"required":["id","experienceUsd","valuedPairs","valuedCustomers"],"additionalProperties":false},"description":"Each competitor's dollars across the lines; they add up to experienceUsd, to the cent. Largest in size first"}},"required":["foundPairs","matchedPairs","ourMatchedScore","competitorScore","gapPts","customers","experienceUsd","valuedLines","valuedCustomers","passRate","averageStars","lines","competitors"],"additionalProperties":false},"ExperienceCompetitorsItem":{"type":"object","properties":{"id":{"type":"string","description":"The competitor's website id, as destinations[].id names it"},"name":{"type":"string"},"matchedPairs":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Matched pairs: one visit to the campaign's website and the same customer's visit to the competitor's in the same cycle, on the same device. Against one competitor a pair is one journey of the campaign's website"},"customers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct customers behind the matched pairs"},"wins":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The matched pairs the campaign's website won: its journey passed and the competitor's failed, or both passed and its journey earned more stars"},"losses":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The matched pairs the competitor won, by the same rule. The rest decide nothing (both failed, equal stars, a pass with no stars, or a failure blamed on the shopper), so wins plus losses can be fewer than matchedPairs, and the record can point the other way from gapPts"},"ours":{"type":"object","properties":{"experienceScore":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The Experience Score of this side of the matched pairs, 0 to 100, valued as experience.campaign-analytics.get values a segment's; null when it has none to claim"},"passRatePct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The site pass rate over this side of the matched pairs, 0 to 100"},"averageStars":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Mean stars over this side's rated journeys in the matched pairs"},"judgedJourneys":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"This side's journeys in the pass rate's denominator: all but the failures blamed on the shopper"}},"required":["experienceScore","passRatePct","averageStars","judgedJourneys"],"additionalProperties":false,"description":"The campaign's own website over the matched pairs only, so it can differ from the website's own score"},"theirs":{"type":"object","properties":{"experienceScore":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The Experience Score of this side of the matched pairs, 0 to 100, valued as experience.campaign-analytics.get values a segment's; null when it has none to claim"},"passRatePct":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The site pass rate over this side of the matched pairs, 0 to 100"},"averageStars":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Mean stars over this side's rated journeys in the matched pairs"},"judgedJourneys":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"This side's journeys in the pass rate's denominator: all but the failures blamed on the shopper"}},"required":["experienceScore","passRatePct","averageStars","judgedJourneys"],"additionalProperties":false},"gapPts":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Our score less theirs, in points; null unless both sides have a score"},"experienceUsd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The match's Experience dollars, plus or minus: a competitor's across the business's products, its revenue lines (its parts of the lines added up, so their sign can differ from gapPts's), or a line's against one competitor; null without a worth or a gap to value"},"valuedPairs":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The matched pairs experienceUsd stands on: a competitor's on the products (revenue lines) with a worth, which can be fewer than matchedPairs; a line's own. 0 without dollars"},"valuedCustomers":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct customers behind valuedPairs: the sample the dollars' precision reads, as customers is the gap's. 0 without dollars"},"size":{"type":"number","minimum":0,"description":"What the match weighs on the map, in sizedBy's unit"}},"required":["id","name","matchedPairs","customers","wins","losses","ours","theirs","gapPts","experienceUsd","valuedPairs","valuedCustomers","size"],"additionalProperties":false},"ExperienceExperimentalConditions":{"type":"object","properties":{"version":{"type":"number","const":1},"browserSessionId":{"type":"string","minLength":1},"browserAttemptOrdinal":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"browserVersion":{"type":"string","minLength":1},"userAgent":{"type":"string","minLength":1},"browserDevice":{"type":"string","enum":["desktop","mobile"]},"viewport":{"type":"object","properties":{"width":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"height":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["width","height"],"additionalProperties":false},"proxyCountry":{"type":"string","pattern":"^[A-Z]{2}$"},"proxyState":{"type":"string","pattern":"^[A-Z]{2}$"},"providerRegion":{"type":"string","const":"us-east-1"},"blockAds":{"type":"boolean"},"solveCaptchas":{"type":"boolean"},"locale":{"type":"string","minLength":1},"timezone":{"type":"string","minLength":1},"interactionPolicy":{"type":"string","const":"observation-only-v2"}},"required":["version","browserSessionId","browserAttemptOrdinal","browserVersion","userAgent","browserDevice","viewport","proxyCountry","providerRegion","blockAds","solveCaptchas","locale","timezone","interactionPolicy"],"additionalProperties":false},"ExperienceItemExperimentalConditions":{"type":"object","properties":{"version":{"type":"number","const":2},"kind":{"type":"string","const":"web"},"browserSessionId":{"type":"string","minLength":1},"browserAttemptOrdinal":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"browserVersion":{"type":"string","minLength":1},"userAgent":{"type":"string","minLength":1},"browserDevice":{"type":"string","enum":["desktop","mobile"]},"viewport":{"type":"object","properties":{"width":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"height":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["width","height"],"additionalProperties":false},"proxyCountry":{"type":"string","pattern":"^[A-Z]{2}$"},"proxyState":{"type":"string","pattern":"^[A-Z]{2}$"},"providerRegion":{"type":"string","const":"us-east-1"},"blockAds":{"type":"boolean"},"solveCaptchas":{"type":"boolean"},"locale":{"type":"string","minLength":1},"timezone":{"type":"string","minLength":1},"challenges":{"type":"object","properties":{"solved":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"unsolved":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"timedOut":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"pageClosed":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"additionalProperties":false},"initialChallenge":{"type":"object","properties":{"outcome":{"type":"string","enum":["solved","unsolved","timed_out","page_closed"]},"durationMs":{"type":"integer","minimum":0,"maximum":9007199254740991},"allowanceSpent":{"type":"boolean","const":true}},"required":["outcome","durationMs"],"additionalProperties":false},"emulation":{"type":"string","enum":["none","android_chrome_phone"]},"automationDwell":{"type":"object","properties":{"firstLoadIdleTimeoutMs":{"type":"integer","minimum":0,"maximum":9007199254740991},"firstLoadSettleMs":{"type":"integer","minimum":0,"maximum":9007199254740991},"postActionMs":{"type":"integer","minimum":0,"maximum":9007199254740991},"navigationActionMinimumMs":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["firstLoadIdleTimeoutMs","firstLoadSettleMs","postActionMs","navigationActionMinimumMs"],"additionalProperties":false},"ignoreCertificateErrors":{"type":"boolean"},"initialDialog":{"type":"object","properties":{"type":{"type":"string","enum":["alert","confirm","prompt","beforeunload"]},"answer":{"type":"string","enum":["accepted","dismissed"]}},"required":["type","answer"],"additionalProperties":false},"userAgentProbe":{"type":"string","const":"failed"},"devicePixelRatio":{"type":"number","exclusiveMinimum":0},"actionPolicy":{"type":"string","enum":["observe","test_actions"]},"authenticated":{"type":"boolean"},"providerRecording":{"type":"boolean"},"providerLogging":{"type":"boolean"}},"required":["version","kind","browserSessionId","browserAttemptOrdinal","browserVersion","userAgent","browserDevice","viewport","proxyCountry","providerRegion","blockAds","solveCaptchas","locale","timezone","actionPolicy","authenticated","providerRecording","providerLogging"],"additionalProperties":false},"ExperienceReplayItemExperimentalConditions":{"type":"object","properties":{"version":{"type":"number","const":2},"kind":{"type":"string","const":"native"},"browserSessionId":{"type":"string","minLength":1},"browserAttemptOrdinal":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"platform":{"type":"string","enum":["ios","android"]},"deviceName":{"type":"string","minLength":1},"osVersion":{"type":"string","minLength":1},"buildId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"buildSha256":{"type":"string","pattern":"^[a-f0-9]{64}$"},"appId":{"type":"string","minLength":1},"versionLabel":{"type":"string","minLength":1},"viewport":{"type":"object","properties":{"width":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"height":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["width","height"],"additionalProperties":false},"deviceViewport":{"type":"object","properties":{"width":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"height":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"x":{"type":"integer","minimum":0,"maximum":9007199254740991},"y":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["width","height","x","y"],"additionalProperties":false},"actionPolicy":{"type":"string","enum":["observe","test_actions"]},"authenticated":{"type":"boolean"},"providerRecording":{"type":"boolean","const":false}},"required":["version","kind","browserSessionId","browserAttemptOrdinal","platform","deviceName","osVersion","buildId","buildSha256","appId","versionLabel","viewport","deviceViewport","actionPolicy","authenticated","providerRecording"],"additionalProperties":false},"ExperienceCustomerMission":{"anyOf":[{"type":"object","properties":{"version":{"type":"number","const":1},"preparationObjectiveId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customerVersionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"contentFingerprint":{"type":"string","pattern":"^[a-f0-9]{64}$"},"motivation":{"type":"string","minLength":10,"maxLength":1200},"stoppingConditions":{"minItems":1,"maxItems":5,"type":"array","items":{"type":"string","minLength":5,"maxLength":400}},"criteriaSources":{"minItems":1,"maxItems":5,"type":"array","items":{"maxItems":12,"type":"array","items":{"type":"string","enum":["displayName","audienceMixId","revenueMixId","channelMixId","regionalMixId","ageMixId","householdIncomeMixId","urbanicityMixId","raceEthnicityMixId","lifeStageMixId","jobMixId","triggerTypeMixId","genderMixId","educationMixId","companySizeMixId","buyerRoleMixId","seniorityMixId","firstNameInitialMixId","lastNameInitialMixId","intentStageMixId","languageMixId","occupationMixId","trendId","consumerConversationTier","consumerConversationPolicyVersion","name","age","householdComposition","householdIncome","educationLevel","employer","employerEvidenceUrl","employerEvidenceDomain","jobTitle","yearsInRole","addressDetail","geoScopeFingerprint","geoSeedId","countryCode","subdivisionCode","locality","postalCode","buyerType","operatingEnvironment","headcount","annualRevenue","stakeholders","economicPosition","constraints","jobSummary","jobTagline","functionalJob","emotionalJob","socialJob","trigger","successDefinition","avatarUrl","voiceId"]}}}},"required":["version","preparationObjectiveId","customerVersionId","contentFingerprint","motivation","stoppingConditions","criteriaSources"],"additionalProperties":false},{"type":"null"}]},"ExperienceEvaluation":{"anyOf":[{"type":"object","properties":{"achieved":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"version":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"evidenceDisposition":{"type":"string","enum":["sufficient","insufficient","policy_limited","infrastructure_limited","scenario_mismatch"]},"moments":{"readOnly":true,"type":"array","items":{"type":"object","properties":{"stepNumber":{"type":"integer","minimum":0,"maximum":120},"artifactId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"generation":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"assessment":{"type":"string","enum":["progress","reached","uncertain","friction","blocked","unassessed"]},"finding":{"type":"string","minLength":5,"maxLength":600}},"required":["stepNumber","artifactId","generation","assessment","finding"],"additionalProperties":false}},"qualityStars":{"anyOf":[{"type":"number"},{"type":"null"}]},"legacyProgressScore":{"anyOf":[{"type":"number"},{"type":"null"}]},"criteria":{"readOnly":true,"type":"array","items":{"readOnly":true,"type":"object","properties":{"criterion":{"type":"string"},"achieved":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"evidenceSteps":{"readOnly":true,"type":"array","items":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"finding":{"type":"string"}},"required":["criterion","achieved","evidenceSteps","finding"],"additionalProperties":false}},"frictions":{"readOnly":true,"maxItems":10,"type":"array","items":{"type":"object","properties":{"step":{"type":"integer","minimum":0,"maximum":9007199254740991},"what":{"type":"string","minLength":5,"maxLength":600},"severity":{"type":"string","enum":["blocker","major","minor"]}},"required":["step","what","severity"],"additionalProperties":false}},"blockedBy":{"type":"string","enum":["none","site","shopper","external","policy","infrastructure","unknown","scenario"]}},"required":["achieved","qualityStars","legacyProgressScore"],"additionalProperties":false},{"type":"null"}]},"ExperienceFrames":{"type":"array","items":{"type":"object","properties":{"index":{"type":"integer","minimum":0,"maximum":9007199254740991},"stepNumber":{"type":"number"},"screenshotUrl":{"type":"string"},"artifactId":{"type":"string"},"generation":{"type":"number"},"currentUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"reasoning":{"anyOf":[{"type":"string"},{"type":"null"}]},"narrationStartMs":{"anyOf":[{"type":"number"},{"type":"null"}]},"narrationEndMs":{"anyOf":[{"type":"number"},{"type":"null"}]},"playbackStartMs":{"type":"number"},"playbackEndMs":{"type":"number"},"sentiment":{"anyOf":[{"type":"string","enum":["neutral","positive","warning","negative"]},{"type":"null"}]},"action":{"anyOf":[{"type":"object","properties":{"type":{"type":"string"},"coordinates":{"type":"object","properties":{"x":{"type":"number"},"y":{"type":"number"}},"required":["x","y"],"additionalProperties":false},"text":{"type":"string"}},"required":["type"],"additionalProperties":false},{"type":"null"}]},"elapsedMs":{"type":"number"},"elapsedMsEstimated":{"type":"boolean"}},"required":["index","stepNumber","screenshotUrl","currentUrl","reasoning","narrationStartMs","narrationEndMs","playbackStartMs","playbackEndMs","sentiment","action","elapsedMs","elapsedMsEstimated"],"additionalProperties":false}},"ExperienceCurrent":{"type":"object","properties":{"runId":{"type":"string"},"customerId":{"type":"string"},"customerName":{"type":"string"},"visitKey":{"type":"string"},"repetition":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"browserDevice":{"type":"string","enum":["desktop","mobile"]},"agent":{"type":"string","enum":["point11","dots","spark","muse","grok_bot"],"description":"The agent that shopped it; one experiment's visits share it"},"nativeApp":{"anyOf":[{"type":"object","properties":{"platform":{"type":"string","enum":["ios","android"]},"buildId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$"},"appId":{"type":"string","minLength":1,"maxLength":255},"versionLabel":{"type":"string","minLength":1,"maxLength":120},"deviceName":{"type":"string","minLength":1,"maxLength":120},"osVersion":{"type":"string","minLength":1,"maxLength":80}},"required":["platform","buildId","sha256","appId","versionLabel","deviceName","osVersion"],"additionalProperties":false},{"type":"null"}]}},"required":["runId","customerId","customerName","visitKey","repetition","browserDevice","agent","nativeApp"],"additionalProperties":false},"ExperienceReplayItemExperimentalConditions2":{"anyOf":[{"anyOf":[{"$ref":"#/components/schemas/ExperienceExperimentalConditions"},{"$ref":"#/components/schemas/ExperienceItemExperimentalConditions"},{"$ref":"#/components/schemas/ExperienceReplayItemExperimentalConditions"},{"type":"object","properties":{"version":{"type":"number","const":2},"kind":{"type":"string","const":"ios_safari"},"browserSessionId":{"type":"string","minLength":1},"browserAttemptOrdinal":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"browserDevice":{"type":"string","const":"ios_safari"},"deviceName":{"type":"string","minLength":1},"osVersion":{"type":"string","minLength":1},"browserVersion":{"type":"string","minLength":1},"userAgent":{"type":"string","minLength":1},"locale":{"type":"string","minLength":1},"timezone":{"type":"string","minLength":1},"viewport":{"type":"object","properties":{"width":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"height":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["width","height"],"additionalProperties":false},"deviceViewport":{"type":"object","properties":{"width":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"height":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"x":{"type":"integer","minimum":0,"maximum":9007199254740991},"y":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["width","height","x","y"],"additionalProperties":false},"actionPolicy":{"type":"string","enum":["observe","test_actions"]},"authenticated":{"type":"boolean","const":false},"providerRecording":{"type":"boolean","const":false}},"required":["version","kind","browserSessionId","browserAttemptOrdinal","browserDevice","deviceName","osVersion","browserVersion","userAgent","locale","timezone","viewport","deviceViewport","actionPolicy","authenticated","providerRecording"],"additionalProperties":false}]},{"type":"null"}]},"ExperienceNavigation":{"anyOf":[{"type":"object","properties":{"campaignId":{"anyOf":[{"type":"string"},{"type":"null"}]},"current":{"anyOf":[{"$ref":"#/components/schemas/ExperienceCurrent2"},{"type":"null"}]},"visits":{"type":"array","items":{"$ref":"#/components/schemas/ExperienceCurrent2"}}},"required":["campaignId","current","visits"],"additionalProperties":false},{"type":"null"}]},"ExperienceCurrent2":{"type":"object","properties":{"runId":{"type":"string"},"customerId":{"type":"string"},"customerName":{"type":"string"},"visitKey":{"type":"string"},"repetition":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"browserDevice":{"type":"string","enum":["desktop","mobile","ios_safari"]},"agent":{"type":"string","enum":["point11","dots","spark","muse","grok_bot"],"description":"The agent that shopped it; one experiment's visits share it"},"nativeApp":{"anyOf":[{"type":"object","properties":{"platform":{"type":"string","enum":["ios","android"]},"buildId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$"},"appId":{"type":"string","minLength":1,"maxLength":255},"versionLabel":{"type":"string","minLength":1,"maxLength":120},"deviceName":{"type":"string","minLength":1,"maxLength":120},"osVersion":{"type":"string","minLength":1,"maxLength":80}},"required":["platform","buildId","sha256","appId","versionLabel","deviceName","osVersion"],"additionalProperties":false},{"type":"null"}]}},"required":["runId","customerId","customerName","visitKey","repetition","browserDevice","agent","nativeApp"],"additionalProperties":false},"ExperienceWebAuthentication":{"anyOf":[{"oneOf":[{"type":"object","properties":{"method":{"type":"string","const":"browser_session"},"signedInUrl":{"type":"string","maxLength":2000,"format":"uri"},"signedInSelector":{"type":"string","minLength":1,"maxLength":500}},"required":["method","signedInUrl","signedInSelector"],"additionalProperties":false},{"type":"object","properties":{"method":{"type":"string","const":"password_form"},"signedInUrl":{"type":"string","maxLength":2000,"format":"uri"},"signedInSelector":{"type":"string","minLength":1,"maxLength":500},"loginUrl":{"type":"string","maxLength":2000,"format":"uri"},"usernameSelector":{"type":"string","minLength":1,"maxLength":500},"passwordSelector":{"type":"string","minLength":1,"maxLength":500},"submitSelector":{"type":"string","minLength":1,"maxLength":500},"totpSelector":{"type":"string","minLength":1,"maxLength":500},"totpSubmitSelector":{"type":"string","minLength":1,"maxLength":500}},"required":["method","signedInUrl","signedInSelector","loginUrl","usernameSelector","passwordSelector","submitSelector"],"additionalProperties":false}]},{"type":"null"}]},"ExperienceNativeAuthentication":{"anyOf":[{"type":"object","properties":{"ios":{"$ref":"#/components/schemas/ExperienceIos"},"android":{"$ref":"#/components/schemas/ExperienceIos"}},"additionalProperties":false},{"type":"null"}]},"ExperienceIos":{"type":"object","properties":{"usernameSelector":{"type":"object","properties":{"using":{"type":"string","enum":["id","accessibility id"]},"value":{"type":"string","minLength":1,"maxLength":500}},"required":["using","value"],"additionalProperties":false},"passwordSelector":{"type":"object","properties":{"using":{"type":"string","enum":["id","accessibility id"]},"value":{"type":"string","minLength":1,"maxLength":500}},"required":["using","value"],"additionalProperties":false},"submitSelector":{"type":"object","properties":{"using":{"type":"string","enum":["id","accessibility id"]},"value":{"type":"string","minLength":1,"maxLength":500}},"required":["using","value"],"additionalProperties":false},"signedInSelector":{"type":"object","properties":{"using":{"type":"string","enum":["id","accessibility id"]},"value":{"type":"string","minLength":1,"maxLength":500}},"required":["using","value"],"additionalProperties":false},"totpSelector":{"type":"object","properties":{"using":{"type":"string","enum":["id","accessibility id"]},"value":{"type":"string","minLength":1,"maxLength":500}},"required":["using","value"],"additionalProperties":false},"totpSubmitSelector":{"type":"object","properties":{"using":{"type":"string","enum":["id","accessibility id"]},"value":{"type":"string","minLength":1,"maxLength":500}},"required":["using","value"],"additionalProperties":false}},"required":["usernameSelector","passwordSelector","submitSelector","signedInSelector"],"additionalProperties":false},"ExperienceDomainVerification":{"type":"object","properties":{"verified":{"type":"boolean","description":"Whether your organization has proved it controls every host in hosts at this revision. Until it has, journeys treat the website as one you do not own: they honour its robots.txt behind the full site fence, take no test actions, never sign in, and do not run iPhone Safari."},"verifiedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"hosts":{"type":"array","items":{"type":"string"},"description":"The hosts of the approved origins the proof covers."},"record":{"type":"object","properties":{"type":{"type":"string","const":"TXT"},"label":{"type":"string"},"value":{"type":"string"}},"required":["type","label","value"],"additionalProperties":false,"description":"The DNS record that proves a host: a TXT record named label, a dot and the host (or a parent domain of it, which covers every host under it), holding value. A domain your organization verified for single sign-on proves every host under it without one. Then call experience_connections_verify_domain_v1."}},"required":["verified","verifiedAt","hosts","record"],"additionalProperties":false},"CollaborationThreadsItem":{"type":"object","properties":{"id":{"type":"string"},"artifactType":{"type":"string"},"artifactId":{"type":"string"},"surfaceId":{"type":"string"},"canonicalHref":{"type":"string","description":"The dashboard path the thread was left on"},"anchor":{"$ref":"#/components/schemas/CollaborationAnchor"},"anchorKey":{"type":"string"},"viewState":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/JsonValue"}},"snapshot":{"type":"object","properties":{"version":{"type":"string"},"title":{"type":"string"},"subtitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"generatedAt":{"type":"string"},"values":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"},"detail":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["label","value"],"additionalProperties":false}}},"required":["version","title","generatedAt","values"],"additionalProperties":false,"description":"What the anchor showed when the thread was started"},"status":{"type":"string","enum":["open","resolved"]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"resolvedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"creator":{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"type":"string"},"imageUrl":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","email","imageUrl"],"additionalProperties":false},"resolvedBy":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"type":"string"},"imageUrl":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","email","imageUrl"],"additionalProperties":false},{"type":"null"}]},"comments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"parentCommentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"body":{"type":"string"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"editedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"author":{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"type":"string"},"imageUrl":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","email","imageUrl"],"additionalProperties":false},"mentions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"type":"string"},"imageUrl":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","email","imageUrl"],"additionalProperties":false}},"invitations":{"type":"array","items":{"type":"object","properties":{"invitationId":{"type":"string"},"email":{"type":"string"},"status":{"type":"string","enum":["pending","accepted","revoked","expired"]},"joined":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"type":"string"},"imageUrl":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","email","imageUrl"],"additionalProperties":false},{"type":"null"}],"description":"The member the invitation became, once accepted"}},"required":["invitationId","email","status","joined"],"additionalProperties":false}}},"required":["id","parentCommentId","body","createdAt","editedAt","author","mentions","invitations"],"additionalProperties":false},"description":"The opening comment and the most recent replies, oldest first"},"mentionUserIds":{"type":"array","items":{"type":"string"}},"unread":{"type":"boolean","description":"Whether the thread changed since the caller last read it"},"mentionedMe":{"type":"boolean","description":"Whether any comment in the thread mentions the caller"}},"required":["id","artifactType","artifactId","surfaceId","canonicalHref","anchor","anchorKey","viewState","snapshot","status","createdAt","updatedAt","resolvedAt","creator","resolvedBy","comments","mentionUserIds","unread","mentionedMe"],"additionalProperties":false},"CollaborationAnchor":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"metric_card"},"key":{"type":"string","minLength":1,"maxLength":200},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["kind","key","label"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"table_card"},"key":{"type":"string","minLength":1,"maxLength":200},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["kind","key","label"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"report_section"},"key":{"type":"string","minLength":1,"maxLength":200},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["kind","key","label"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"replay"},"key":{"type":"string","const":"replay"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["kind","key","label"],"additionalProperties":false}]},"BillingUsage":{"type":"array","items":{"type":"object","properties":{"identity":{"type":"string"},"productSlug":{"type":"string"},"dimensionKey":{"type":"string"},"unitPriceCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"included":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"used":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"held":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"remaining":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"overageUnits":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"overageUsd":{"type":"string"},"pending":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"share":{"type":"number"},"productName":{"anyOf":[{"type":"string"},{"type":"null"}]},"productId":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"type":"object","properties":{"singular":{"type":"string"},"plural":{"type":"string"}},"required":["singular","plural"],"additionalProperties":false},"placement":{"type":"string","enum":["campaigns","alpha","other"]}},"required":["identity","productSlug","dimensionKey","unitPriceCents","included","used","held","remaining","overageUnits","overageUsd","pending","share","productName","productId","label","placement"],"additionalProperties":false}},"AccountDelivery":{"type":"object","properties":{"outcome":{"type":"string","enum":["sent","retryable_failed","reconciliation_required","blocked"]},"operationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"adopted":{"type":"boolean"},"retryUntil":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"reason":{"anyOf":[{"type":"string","enum":["operation_conflict","request_changed","delivery_state_ambiguous","invitation_not_pending","invitation_authority_revoked","recipient_suppressed","provider_unavailable","provider_rejected"]},{"type":"null"}]}},"required":["outcome","operationId","adopted","retryUntil","reason"],"additionalProperties":false},"AccountBranding":{"type":"object","properties":{"id":{"type":"string"},"organizationId":{"type":"string"},"logoUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"faviconUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"primaryColor":{"anyOf":[{"type":"string"},{"type":"null"}]},"accentColor":{"anyOf":[{"type":"string"},{"type":"null"}]},"fontFamily":{"anyOf":[{"type":"string"},{"type":"null"}]},"customCss":{"anyOf":[{"type":"string"},{"type":"null"}]},"widgetPosition":{"anyOf":[{"type":"string","enum":["bottom-right","bottom-left","top-right","top-left"]},{"type":"null"}]},"widgetGreeting":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["id","organizationId","logoUrl","faviconUrl","primaryColor","accentColor","fontFamily","customCss","widgetPosition","widgetGreeting","createdAt","updatedAt"],"additionalProperties":false},"AccountBranding2":{"type":"object","properties":{"id":{"type":"string"},"organizationId":{"type":"string"},"primaryColor":{"anyOf":[{"type":"string"},{"type":"null"}]},"accentColor":{"anyOf":[{"type":"string"},{"type":"null"}]},"fontFamily":{"anyOf":[{"type":"string"},{"type":"null"}]},"customCss":{"anyOf":[{"type":"string"},{"type":"null"}]},"widgetPosition":{"anyOf":[{"type":"string","enum":["bottom-right","bottom-left","top-right","top-left"]},{"type":"null"}]},"widgetGreeting":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["id","organizationId","primaryColor","accentColor","fontFamily","customCss","widgetPosition","widgetGreeting","createdAt","updatedAt"],"additionalProperties":false},"AccountOpenWindow":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"startsAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"endsAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"When support stops being able to view the app as one of your members"}},"required":["id","startsAt","endsAt"],"additionalProperties":false},{"type":"null"}],"description":"The window open now, or null when none is"},"CampaignsDataItem":{"oneOf":[{"type":"object","properties":{"id":{"type":"string"},"campaignKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"type":"string"},"brandName":{"anyOf":[{"type":"string"},{"type":"null"}]},"url":{"type":"string"},"domain":{"type":"string"},"status":{"type":"string","enum":["active","paused","archived","deleted"]},"schedule":{"$ref":"#/components/schemas/CampaignsSchedule"},"work":{"$ref":"#/components/schemas/CampaignsWork"},"execution":{"$ref":"#/components/schemas/CampaignsExecution"},"launch":{"type":"object","properties":{"awaitingFunding":{"type":"boolean"},"refused":{"type":"boolean"}},"required":["awaitingFunding","refused"],"additionalProperties":false},"readiness":{"type":"object","properties":{"state":{"type":"string","enum":["ready","preparing","needs_attention"]},"message":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["state","message"],"additionalProperties":false},"subtype":{"anyOf":[{"type":"string"},{"type":"null"}]},"targetKind":{"anyOf":[{"type":"string","enum":["profile","physical_locations"]},{"type":"null"}]},"forecastAudience":{"type":"boolean","description":"Whether a Discovery campaign's customers are its forecast's alone (forecast mode, as Bootup's Forecast campaign); false for any other campaign."},"customerCount":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}],"description":"The customers the campaign shops: Discovery's customer target (it grows with the roster), Research's interview target, an Experience Burst's launch customers, and an Experience Pulse's source Discovery campaign's customer target. Null while a Pulse names no source. Who is on the roster now is `rosterCustomerCount`."},"createdAt":{"type":"string","description":"ISO timestamp."},"updatedAt":{"type":"string","description":"ISO timestamp."},"latestEntry":{"$ref":"#/components/schemas/CampaignsLatestEntry"},"rosterCustomerCount":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}],"description":"Who is on a Discovery campaign's roster now, whom its runs interview, and an Experience Pulse's source Discovery campaign's: a customer removed by name leaves `customerCount`, the planned target, where it was, so the two can differ. Null until anyone has joined the roster, and for a Research campaign and an Experience Burst, which `customerCount` alone names."},"held":{"type":"boolean","description":"Point11 holds the campaign's new work: an operator stopped one of its runs and has not released it, so nothing it placed starts. Its status reads On hold while it is active."},"supportOwned":{"type":"boolean","description":"Point11 support owns the campaign's failed work: an open delivery issue is recorded for it."},"brandIcon":{"anyOf":[{"type":"object","properties":{"url":{"type":"string","description":"The stored favicon: a public object URL"},"tone":{"type":"string","enum":["dark","light","mixed","unknown"]},"transparent":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"needsLightBackplate":{"type":"boolean"},"needsDarkBackplate":{"type":"boolean"}},"required":["url","tone","transparent","needsLightBackplate","needsDarkBackplate"],"additionalProperties":false},{"type":"null"}],"description":"The favicon Discovery's source identity stored for the brand's website (`url`, the website the campaign runs on behalf of); null when none is stored, and the brand draws its website's initial."},"product":{"type":"string","enum":["discovery","research"]},"type":{"type":"string","description":"\"Discovery\" or the Research playbook's label."}},"required":["id","campaignKey","name","brandName","url","domain","status","schedule","work","execution","launch","readiness","subtype","targetKind","forecastAudience","customerCount","createdAt","updatedAt","latestEntry","rosterCustomerCount","held","supportOwned","brandIcon","product","type"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string"},"campaignKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"type":"string"},"brandName":{"anyOf":[{"type":"string"},{"type":"null"}]},"url":{"type":"string"},"domain":{"type":"string"},"status":{"type":"string","enum":["active","paused","archived","deleted"]},"schedule":{"$ref":"#/components/schemas/CampaignsSchedule"},"work":{"$ref":"#/components/schemas/CampaignsWork"},"execution":{"$ref":"#/components/schemas/CampaignsExecution"},"launch":{"type":"object","properties":{"awaitingFunding":{"type":"boolean"},"refused":{"type":"boolean"}},"required":["awaitingFunding","refused"],"additionalProperties":false},"readiness":{"type":"object","properties":{"state":{"type":"string","enum":["ready","preparing","needs_attention"]},"message":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["state","message"],"additionalProperties":false},"subtype":{"anyOf":[{"type":"string"},{"type":"null"}]},"targetKind":{"anyOf":[{"type":"string","enum":["profile","physical_locations"]},{"type":"null"}]},"forecastAudience":{"type":"boolean","description":"Whether a Discovery campaign's customers are its forecast's alone (forecast mode, as Bootup's Forecast campaign); false for any other campaign."},"customerCount":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}],"description":"The customers the campaign shops: Discovery's customer target (it grows with the roster), Research's interview target, an Experience Burst's launch customers, and an Experience Pulse's source Discovery campaign's customer target. Null while a Pulse names no source. Who is on the roster now is `rosterCustomerCount`."},"createdAt":{"type":"string","description":"ISO timestamp."},"updatedAt":{"type":"string","description":"ISO timestamp."},"latestEntry":{"$ref":"#/components/schemas/CampaignsLatestEntry"},"rosterCustomerCount":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}],"description":"Who is on a Discovery campaign's roster now, whom its runs interview, and an Experience Pulse's source Discovery campaign's: a customer removed by name leaves `customerCount`, the planned target, where it was, so the two can differ. Null until anyone has joined the roster, and for a Research campaign and an Experience Burst, which `customerCount` alone names."},"held":{"type":"boolean","description":"Point11 holds the campaign's new work: an operator stopped one of its runs and has not released it, so nothing it placed starts. Its status reads On hold while it is active."},"supportOwned":{"type":"boolean","description":"Point11 support owns the campaign's failed work: an open delivery issue is recorded for it."},"brandIcon":{"anyOf":[{"type":"object","properties":{"url":{"type":"string","description":"The stored favicon: a public object URL"},"tone":{"type":"string","enum":["dark","light","mixed","unknown"]},"transparent":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"needsLightBackplate":{"type":"boolean"},"needsDarkBackplate":{"type":"boolean"}},"required":["url","tone","transparent","needsLightBackplate","needsDarkBackplate"],"additionalProperties":false},{"type":"null"}],"description":"The favicon Discovery's source identity stored for the brand's website (`url`, the website the campaign runs on behalf of); null when none is stored, and the brand draws its website's initial."},"product":{"type":"string","const":"experience"},"type":{"type":"string","const":"Experience"},"experience":{"type":"object","properties":{"mode":{"type":"string","enum":["pulse","burst"]},"targetSummary":{"type":"object","properties":{"platforms":{"type":"array","items":{"type":"string","enum":["web","ios","android"]}},"accessModes":{"type":"array","items":{"type":"string","enum":["public","signed_in"]}}},"required":["platforms","accessModes"],"additionalProperties":false}},"required":["mode","targetSummary"],"additionalProperties":false}},"required":["id","campaignKey","name","brandName","url","domain","status","schedule","work","execution","launch","readiness","subtype","targetKind","forecastAudience","customerCount","createdAt","updatedAt","latestEntry","rosterCustomerCount","held","supportOwned","brandIcon","product","type","experience"],"additionalProperties":false}]},"CampaignsSchedule":{"oneOf":[{"type":"object","properties":{"mode":{"type":"string","const":"calendar"},"issue":{"anyOf":[{"type":"string"},{"type":"null"}]},"clockStarted":{"type":"boolean","description":"Whether the campaign's clock has started. An always-on Experience campaign's starts once its first run delivers a visit; until then it runs no month."},"nextAt":{"description":"ISO timestamp at which the clock an always-on Experience campaign's first accepted run started next opens a cycle. It is the stored instant: a promise only while the campaign is Active, has no schedule issue, Point11 does not hold it, and the account admits its work (`execution.admissionAllowed`), and once passed, a cycle due to be planned. A visit placed ahead (`execution.activity.nextTargetAt`) comes first. Absent for a Discovery campaign, whose calendar names its next customer, and for a clock no accepted run started.","type":"string"},"placesAt":{"description":"ISO timestamp of the daily slice at which a recurring Discovery campaign next places customers: its month's first slice while that month is not yet written, else the next UTC month's first, which writes that month's plan. Its Activity names it as Next only once no stored customer remains ahead (`execution.activity.nextTargetAt` null), and only while the campaign is Active, has no schedule issue, Point11 does not hold it, and the account admits its work. Absent for any other campaign.","type":"string"}},"required":["mode","issue","clockStarted"],"additionalProperties":false},{"type":"object","properties":{"mode":{"type":"string","const":"once"},"issue":{"anyOf":[{"type":"string"},{"type":"null"}]},"nextAt":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["mode","issue","nextAt"],"additionalProperties":false},{"type":"object","properties":{"mode":{"type":"string","const":"recurring"},"issue":{"anyOf":[{"type":"string"},{"type":"null"}]},"frequency":{"type":"string","enum":["daily","weekly","monthly","quarterly"]},"nextAt":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["mode","issue","frequency","nextAt"],"additionalProperties":false},{"type":"object","properties":{"mode":{"type":"string","const":"source"},"issue":{"anyOf":[{"type":"string"},{"type":"null"}]},"source":{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string","enum":["active","paused","archived","deleted"]},{"type":"null"}]}},"required":["id","name","status"],"additionalProperties":false}},"required":["mode","issue","source"],"additionalProperties":false},{"type":"object","properties":{"mode":{"type":"string","const":"unavailable"},"issue":{"type":"string"}},"required":["mode","issue"],"additionalProperties":false}]},"CampaignsWork":{"type":"object","properties":{"state":{"type":"string","enum":["not_started","in_progress","settled","unknown"]},"outcome":{"anyOf":[{"type":"string","enum":["running","succeeded","failed","cancelled","partial"]},{"type":"null"}]},"total":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Entries requested."},"running":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}],"description":"Entries opened and not yet settled; null when unknown. An open entry is not work in flight: `execution.activity` says what runs now."},"succeeded":{"type":"integer","minimum":0,"maximum":9007199254740991},"partial":{"type":"integer","minimum":0,"maximum":9007199254740991},"failed":{"type":"integer","minimum":0,"maximum":9007199254740991},"cancelled":{"type":"integer","minimum":0,"maximum":9007199254740991},"skipped":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["state","outcome","total","running","succeeded","partial","failed","cancelled","skipped"],"additionalProperties":false,"description":"The campaign's entries, one per launch, scheduled firing or run now, whatever its product: an Experience cycle, a Discovery dispatch or a Research run."},"CampaignsExecution":{"type":"object","properties":{"activity":{"anyOf":[{"type":"object","properties":{"campaignId":{"type":"string"},"nextTargetAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"running":{"type":"integer","minimum":0,"maximum":9007199254740991},"queued":{"type":"integer","minimum":0,"maximum":9007199254740991},"due":{"type":"integer","minimum":0,"maximum":9007199254740991},"scheduleTimeZone":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["campaignId","nextTargetAt","running","queued","due","scheduleTimeZone"],"additionalProperties":false},{"type":"null"}],"description":"The campaign's activity from the stored facts campaigns.activities.get.v3 reads for the organization and a product: `nextTargetAt` its stored next customer, `running` the runs Billing admitted for it and has not finished (a reserved dispatch or run from its reservation, before any customer starts), and `due` 1 once that customer's time has passed while Billing admits its product's new work; `queued` is 0 and `scheduleTimeZone` null. Null when those facts could not be read."},"admissionAllowed":{"type":"boolean"},"admissionUnavailable":{"type":"boolean","description":"The admission check could not be made; it holds nothing."},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"subscriptionPaused":{"type":"boolean"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Billing's refusal code behind `reason` when Billing refuses new work, else null."}},"required":["activity","admissionAllowed","admissionUnavailable","reason","subscriptionPaused","code"],"additionalProperties":false,"description":"The account's admission of the campaign's new work, and its execution evidence."},"CampaignsLatestEntry":{"anyOf":[{"$ref":"#/components/schemas/ResearchEntryVariant"},{"type":"null"}],"description":"The campaign's latest entry (its latest launch, run now or scheduled firing) with its units; null before its first. Read one in full with campaigns.campaign-entries.get.v1."},"CampaignsDataItem2":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"campaignId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"product":{"type":"string","enum":["discovery","research","experience"]},"sequence":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"The entry's ordinal among its campaign's entries, from 1."},"origin":{"anyOf":[{"type":"string","enum":["launch","schedule","run_now","recovery"]},{"type":"null"}],"description":"What started the entry: `launch`, `schedule`, `run_now`, or `recovery` (an edit's rerun reads as `run_now`). Null only on an entry recorded before entries named their origin."},"requestedByUserId":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},{"type":"null"}],"description":"The member who launched it or ran it now; null for a scheduled or recovery entry."},"status":{"type":"string","enum":["running","succeeded","failed","cancelled","partial"],"description":"The entry's one outcome, always `progress.outcome`: running until it settles; failed or cancelled when its product or a stop settled it so; otherwise counted from its units, except that a succeeded entry whose units no longer exist stays succeeded."},"startedAt":{"type":"string","description":"ISO timestamp."},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO timestamp; null while it runs."},"failureReason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The code the entry settled with when it failed or was cancelled (for example no_unit_delivered or no_eligible_customers); null otherwise, or when it recorded no code."},"progress":{"$ref":"#/components/schemas/ResearchProgress"},"stored":{"type":"object","properties":{"status":{"type":"string","enum":["running","succeeded","failed","cancelled","partial"],"description":"The status the entry's row holds, as its product or a stop wrote it."},"failureReason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The failure reason as written, which can be an operator's stop note or an internal diagnostic."}},"required":["status","failureReason"],"additionalProperties":false,"description":"Point11's operator door only: the entry's stored status and failure reason as written, from which `status` and `failureReason` are read. Never present on a customer's call."},"economics":{"$ref":"#/components/schemas/CampaignsEconomics"}},"required":["id","campaignId","product","sequence","origin","requestedByUserId","status","startedAt","completedAt","failureReason","progress"],"additionalProperties":false},"CampaignsEconomics":{"type":"object","properties":{"includedQuantity":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Delivered units the billing period's inclusion absorbed."},"overageQuantity":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Delivered units beyond the inclusion."},"chargeCents":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The overage billed for those units, in cents."},"recordedCostUsd":{"type":"number","minimum":0,"description":"The cost recorded on the entry's receipts, in USD; nothing is estimated."},"unpricedReceipts":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Receipts whose exact cost is not known yet: shown as +N unpriced beside the recorded cost."}},"required":["includedQuantity","overageQuantity","chargeCents","recordedCostUsd","unpricedReceipts"],"additionalProperties":false,"description":"Point11's operator door only: what the entry charged and cost, with the receipts not priced yet counted beside the recorded cost. Never present on a customer's call."},"CampaignsDataItem3":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"campaignId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"product":{"type":"string","enum":["discovery","research","experience"]},"sequence":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"The entry's ordinal among its campaign's entries, from 1."},"origin":{"anyOf":[{"type":"string","enum":["launch","schedule","run_now","recovery","edit_rerun"]},{"type":"null"}],"description":"What started the entry: `launch`, `schedule`, `run_now`, `recovery`, or `edit_rerun` (customers a person's edit gave a new version, rerun once on it as their run of the campaign's current period). Null only on an entry recorded before entries named their origin."},"requestedByUserId":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},{"type":"null"}],"description":"The member who launched it or ran it now; null for a scheduled or recovery entry."},"status":{"type":"string","enum":["running","succeeded","failed","cancelled","partial"],"description":"The entry's one outcome, always `progress.outcome`: running until it settles; failed or cancelled when its product or a stop settled it so; otherwise counted from its units, except that a succeeded entry whose units no longer exist stays succeeded."},"startedAt":{"type":"string","description":"ISO timestamp."},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO timestamp; null while it runs."},"failureReason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The code the entry settled with when it failed or was cancelled (for example no_unit_delivered or no_eligible_customers); null otherwise, or when it recorded no code."},"progress":{"$ref":"#/components/schemas/ResearchProgress"},"stored":{"type":"object","properties":{"status":{"type":"string","enum":["running","succeeded","failed","cancelled","partial"],"description":"The status the entry's row holds, as its product or a stop wrote it."},"failureReason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The failure reason as written, which can be an operator's stop note or an internal diagnostic."}},"required":["status","failureReason"],"additionalProperties":false,"description":"Point11's operator door only: the entry's stored status and failure reason as written, from which `status` and `failureReason` are read. Never present on a customer's call."},"economics":{"$ref":"#/components/schemas/CampaignsEconomics"}},"required":["id","campaignId","product","sequence","origin","requestedByUserId","status","startedAt","completedAt","failureReason","progress"],"additionalProperties":false},"CampaignsTargetResults":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"product":{"type":"string","enum":["discovery","research","experience"]},"outcome":{"type":"string","enum":["changed","unchanged","blocked","missing","pending"]},"reason":{"type":"string","enum":["active_paused","paused_resumed","active_deleted","paused_archived","archived_restored","paused_deleted","archived_deleted","already_active","already_paused","already_archived","already_deleted","active_archive_requires_pause","archived_requires_restore","deleted_is_backup_only","invalid_source_state","active_execution","execution_stopping","not_found"]},"priorState":{"anyOf":[{"type":"string","enum":["active","paused","archived","deleted"]},{"type":"null"}],"description":"Null when the campaign is missing."},"resultingState":{"anyOf":[{"type":"string","enum":["active","paused","archived","deleted"]},{"type":"null"}],"description":"Null when the campaign is missing."},"blockingRunId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The run a pending deletion waits on, otherwise null."}},"required":["id","product","outcome","reason","priorState","resultingState","blockingRunId"],"additionalProperties":false},"description":"One entry per distinct campaign, in the order named."},"CampaignsEntries":{"readOnly":true,"type":"array","items":{"anyOf":[{"type":"object","properties":{"lifecycle":{"type":"string","enum":["scheduled","committed","running","finished","cancelled","unknown"]},"waitingReason":{"description":"Why scheduled work is not admitted yet, when known.","anyOf":[{"type":"string"},{"type":"null"}]},"scheduledAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"admittedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"startedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"finishedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"executionId":{"anyOf":[{"type":"string"},{"type":"null"}]},"outcome":{"anyOf":[{"type":"string","enum":["running","succeeded","failed","cancelled","partial"]},{"type":"null"}]},"rerun":{"description":"Present on an edit's rerun: a customer whose edit gave it a new version, rerun once on it as its run of the campaign's current period. It is its own entry and never moves.","type":"boolean","const":true},"inClosedHour":{"description":"Present on a scheduled interaction a person or an order placed in an hour the calendar rules now close. It stays where it was placed.","type":"boolean","const":true},"missed":{"description":"Present on an interaction whose period (its month, or a Research interview's quota period) closed with no run admitting it. Its lifecycle stays `scheduled`, it stays on its day, and it no longer moves.","type":"boolean","const":true},"movedFrom":{"description":"Present when the plan moved the interaction since placing it; absent when a person placed it.","type":"object","properties":{"at":{"type":"string","description":"Where the plan first placed the interaction."},"reason":{"type":"string","enum":["catch_up","rules_save"],"description":"Why the plan moved it: `catch_up`, its slot passed unrun; `rules_save`, the calendar rules changed."}},"required":["at","reason"],"additionalProperties":false},"capabilities":{"type":"object","properties":{"move":{"type":"boolean"},"cancel":{"type":"boolean"},"restore":{"type":"boolean"},"reasonCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"moveMonth":{"description":"`YYYY-MM`: the UTC month a move must stay inside, where one bounds it.","type":"string"},"moveBounds":{"description":"`[from, to)`: the instants a move must land between, beside `moveMonth`, where the interaction has a schedule to move. A move outside them is refused.","type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"}},"required":["from","to"],"additionalProperties":false}},"required":["move","cancel","restore","reasonCode","reason"],"additionalProperties":false},"entryId":{"type":"string"},"lineId":{"type":"string"},"name":{"type":"string"},"targetAt":{"type":"string"},"kind":{"type":"string","const":"customer"},"customerId":{"type":"string"},"customerKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"jobTitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"age":{"anyOf":[{"type":"string"},{"type":"null"}]},"avatarUrl":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["lifecycle","scheduledAt","admittedAt","startedAt","finishedAt","executionId","outcome","capabilities","entryId","lineId","name","targetAt","customerId","customerKey","jobTitle","age","avatarUrl"],"additionalProperties":false},{"type":"object","properties":{"lifecycle":{"type":"string","enum":["scheduled","committed","running","finished","cancelled","unknown"]},"waitingReason":{"description":"Why scheduled work is not admitted yet, when known.","anyOf":[{"type":"string"},{"type":"null"}]},"scheduledAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"admittedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"startedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"finishedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"executionId":{"anyOf":[{"type":"string"},{"type":"null"}]},"outcome":{"anyOf":[{"type":"string","enum":["running","succeeded","failed","cancelled","partial"]},{"type":"null"}]},"rerun":{"description":"Present on an edit's rerun: a customer whose edit gave it a new version, rerun once on it as its run of the campaign's current period. It is its own entry and never moves.","type":"boolean","const":true},"inClosedHour":{"description":"Present on a scheduled interaction a person or an order placed in an hour the calendar rules now close. It stays where it was placed.","type":"boolean","const":true},"missed":{"description":"Present on an interaction whose period (its month, or a Research interview's quota period) closed with no run admitting it. Its lifecycle stays `scheduled`, it stays on its day, and it no longer moves.","type":"boolean","const":true},"movedFrom":{"description":"Present when the plan moved the interaction since placing it; absent when a person placed it.","type":"object","properties":{"at":{"type":"string","description":"Where the plan first placed the interaction."},"reason":{"type":"string","enum":["catch_up","rules_save"],"description":"Why the plan moved it: `catch_up`, its slot passed unrun; `rules_save`, the calendar rules changed."}},"required":["at","reason"],"additionalProperties":false},"capabilities":{"type":"object","properties":{"move":{"type":"boolean"},"cancel":{"type":"boolean"},"restore":{"type":"boolean"},"reasonCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"moveMonth":{"description":"`YYYY-MM`: the UTC month a move must stay inside, where one bounds it.","type":"string"},"moveBounds":{"description":"`[from, to)`: the instants a move must land between, beside `moveMonth`, where the interaction has a schedule to move. A move outside them is refused.","type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"}},"required":["from","to"],"additionalProperties":false}},"required":["move","cancel","restore","reasonCode","reason"],"additionalProperties":false},"entryId":{"type":"string"},"lineId":{"type":"string"},"name":{"type":"string"},"targetAt":{"type":"string"},"kind":{"type":"string","const":"research-run"},"interviewCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"completedInterviewCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"resultsHref":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["lifecycle","scheduledAt","admittedAt","startedAt","finishedAt","executionId","outcome","capabilities","entryId","lineId","name","targetAt","kind","interviewCount","completedInterviewCount","resultsHref"],"additionalProperties":false}]}},"CampaignsCustomerEntriesItem":{"type":"object","properties":{"lifecycle":{"type":"string","enum":["scheduled","committed","running","finished","cancelled","unknown"]},"waitingReason":{"description":"Why scheduled work is not admitted yet, when known.","anyOf":[{"type":"string"},{"type":"null"}]},"scheduledAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"admittedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"startedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"finishedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"executionId":{"anyOf":[{"type":"string"},{"type":"null"}]},"outcome":{"anyOf":[{"type":"string","enum":["running","succeeded","failed","cancelled","partial"]},{"type":"null"}]},"rerun":{"description":"Present on an edit's rerun: a customer whose edit gave it a new version, rerun once on it as its run of the campaign's current period. It is its own entry and never moves.","type":"boolean","const":true},"inClosedHour":{"description":"Present on a scheduled interaction a person or an order placed in an hour the calendar rules now close. It stays where it was placed.","type":"boolean","const":true},"missed":{"description":"Present on an interaction whose period (its month, or a Research interview's quota period) closed with no run admitting it. Its lifecycle stays `scheduled`, it stays on its day, and it no longer moves.","type":"boolean","const":true},"movedFrom":{"description":"Present when the plan moved the interaction since placing it; absent when a person placed it.","type":"object","properties":{"at":{"type":"string","description":"Where the plan first placed the interaction."},"reason":{"type":"string","enum":["catch_up","rules_save"],"description":"Why the plan moved it: `catch_up`, its slot passed unrun; `rules_save`, the calendar rules changed."}},"required":["at","reason"],"additionalProperties":false},"capabilities":{"type":"object","properties":{"move":{"type":"boolean"},"cancel":{"type":"boolean"},"restore":{"type":"boolean"},"reasonCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"moveMonth":{"description":"`YYYY-MM`: the UTC month a move must stay inside, where one bounds it.","type":"string"},"moveBounds":{"description":"`[from, to)`: the instants a move must land between, beside `moveMonth`, where the interaction has a schedule to move. A move outside them is refused.","type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"}},"required":["from","to"],"additionalProperties":false}},"required":["move","cancel","restore","reasonCode","reason"],"additionalProperties":false},"entryId":{"type":"string"},"lineId":{"type":"string"},"name":{"type":"string"},"targetAt":{"type":"string"},"kind":{"type":"string","const":"customer"},"customerId":{"type":"string"},"customerKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"jobTitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"age":{"anyOf":[{"type":"string"},{"type":"null"}]},"avatarUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"campaign":{"type":"object","properties":{"type":{"type":"string","enum":["discovery","research","experience"]},"id":{"type":"string"},"name":{"type":"string"}},"required":["type","id","name"],"additionalProperties":false},"paused":{"description":"Paused activity: the campaign's own pause (status Paused) holds this interaction, which will not start while it stays paused, and `showPaused: false` leaves it out of the calendar. A paused subscription marks none, unlike `campaigns[].paused`, which also reads an Active campaign under a paused subscription as paused. Absent otherwise.","type":"boolean","const":true}},"required":["lifecycle","scheduledAt","admittedAt","startedAt","finishedAt","executionId","outcome","capabilities","entryId","lineId","name","targetAt","customerId","customerKey","jobTitle","age","avatarUrl","campaign"],"additionalProperties":false},"PlatformWorkItem":{"type":"object","properties":{"productSlug":{"type":"string"},"kind":{"anyOf":[{"type":"string"},{"type":"null"}]},"campaignType":{"anyOf":[{"type":"string","enum":["discovery","experience","research"]},{"type":"null"}],"description":"The campaign interaction these runs delivered; null for work that is not one."},"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"The UTC day these runs completed."},"delivered":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Units the runs delivered."},"runs":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Runs that recorded a delivered quantity."},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What one delivered unit is (\"conversation\", \"answer\"); null for work no offered capability counts."}},"required":["productSlug","kind","campaignType","day","delivered","runs","unit"],"additionalProperties":false},"BusinessProfile":{"type":"object","properties":{"businessProfileId":{"type":"string"},"locationKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"scopeLabel":{"type":"string"},"annualSalesBasis":{"type":"string"},"profileVersionId":{"type":"string"},"brandName":{"type":"string"},"normalizedUrl":{"type":"string"},"generatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"lines":{"type":"array","items":{"type":"object","properties":{"configurationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"revision":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"source":{"type":"string","enum":["research","configuration"]},"lineId":{"type":"string"},"lineName":{"type":"string"},"lineAvailable":{"type":"boolean"},"revenueWeightPct":{"type":"number"},"samYear":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"annualSalesUsd":{"type":"number"},"marketSharePct":{"type":"number"},"aiInfluencePct":{"type":"number"},"serviceableAvailableMarketUsd":{"type":"number"},"aiInfluencedServiceableAvailableMarketUsd":{"type":"number"},"aiInfluencedSalesUsd":{"type":"number"}},"required":["configurationId","revision","source","lineId","lineName","lineAvailable","revenueWeightPct","samYear","annualSalesUsd","marketSharePct","aiInfluencePct","serviceableAvailableMarketUsd","aiInfluencedServiceableAvailableMarketUsd","aiInfluencedSalesUsd"],"additionalProperties":false}}},"required":["businessProfileId","locationKey","scopeLabel","annualSalesBasis","profileVersionId","brandName","normalizedUrl","generatedAt","lines"],"additionalProperties":false},"BusinessProfile2":{"type":"object","properties":{"businessProfileId":{"type":"string"},"locationKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"scopeLabel":{"type":"string"},"annualSalesBasis":{"type":"string"},"profileVersionId":{"type":"string"},"brandName":{"type":"string"},"normalizedUrl":{"type":"string"},"generatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"lines":{"type":"array","items":{"type":"object","properties":{"configurationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"revision":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"source":{"type":"string","enum":["research","configuration"]},"lineId":{"type":"string"},"lineName":{"type":"string"},"lineAvailable":{"type":"boolean"},"revenueWeightPct":{"type":"number"},"samYear":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"annualSalesUsd":{"type":"number"},"marketSharePct":{"type":"number"},"aiInfluencePct":{"type":"number"},"serviceableAvailableMarketUsd":{"type":"number"},"aiInfluencedServiceableAvailableMarketUsd":{"type":"number"},"onePointWinRateValueUsd":{"type":"number"}},"required":["configurationId","revision","source","lineId","lineName","lineAvailable","revenueWeightPct","samYear","annualSalesUsd","marketSharePct","aiInfluencePct","serviceableAvailableMarketUsd","aiInfluencedServiceableAvailableMarketUsd","onePointWinRateValueUsd"],"additionalProperties":false}}},"required":["businessProfileId","locationKey","scopeLabel","annualSalesBasis","profileVersionId","brandName","normalizedUrl","generatedAt","lines"],"additionalProperties":false},"BusinessLines":{"type":"array","items":{"type":"object","properties":{"configurationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"revision":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"source":{"type":"string","enum":["research","configuration"]},"lineId":{"type":"string"},"lineName":{"type":"string"},"lineAvailable":{"type":"boolean"},"revenueWeightPct":{"type":"number"},"samYear":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"annualSalesUsd":{"anyOf":[{"type":"number"},{"type":"null"}]},"marketSharePct":{"anyOf":[{"type":"number"},{"type":"null"}]},"aiInfluencePct":{"anyOf":[{"type":"number"},{"type":"null"}]},"serviceableAvailableMarketUsd":{"anyOf":[{"type":"number"},{"type":"null"}]},"aiInfluencedServiceableAvailableMarketUsd":{"anyOf":[{"type":"number"},{"type":"null"}]},"aiInfluencedSalesUsd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Annual sales × AI influence: the brand's own sales AI assistants influence. Dollars are a share of the AI-influenced market, not of these sales."}},"required":["configurationId","revision","source","lineId","lineName","lineAvailable","revenueWeightPct","samYear","annualSalesUsd","marketSharePct","aiInfluencePct","serviceableAvailableMarketUsd","aiInfluencedServiceableAvailableMarketUsd","aiInfluencedSalesUsd"],"additionalProperties":false}},"BusinessProfiles":{"type":"array","items":{"type":"object","properties":{"businessProfileId":{"type":"string"},"locationKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"scopeLabel":{"type":"string"},"annualSalesBasis":{"type":"string"},"profileVersionId":{"type":"string"},"brandName":{"type":"string"},"normalizedUrl":{"type":"string"},"generatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"lines":{"$ref":"#/components/schemas/BusinessItemLines"}},"required":["businessProfileId","locationKey","scopeLabel","annualSalesBasis","profileVersionId","brandName","normalizedUrl","generatedAt","lines"],"additionalProperties":false}},"BusinessItemLines":{"type":"array","items":{"type":"object","properties":{"configurationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"revision":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"source":{"type":"string","enum":["research","configuration"]},"lineId":{"type":"string"},"lineName":{"type":"string"},"lineAvailable":{"type":"boolean"},"revenueWeightPct":{"type":"number"},"samYear":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"annualSalesUsd":{"anyOf":[{"type":"number"},{"type":"null"}]},"marketSharePct":{"anyOf":[{"type":"number"},{"type":"null"}]},"aiInfluencePct":{"anyOf":[{"type":"number"},{"type":"null"}]},"serviceableAvailableMarketUsd":{"anyOf":[{"type":"number"},{"type":"null"}]},"aiInfluencedServiceableAvailableMarketUsd":{"anyOf":[{"type":"number"},{"type":"null"}]},"onePointWinRateValueUsd":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["configurationId","revision","source","lineId","lineName","lineAvailable","revenueWeightPct","samYear","annualSalesUsd","marketSharePct","aiInfluencePct","serviceableAvailableMarketUsd","aiInfluencedServiceableAvailableMarketUsd","onePointWinRateValueUsd"],"additionalProperties":false}},"BusinessTotals":{"type":"object","properties":{"aiInfluencedSalesUsd":{"type":"number","description":"The counted lines' AI-influenced sales: the brand's own sales, which influencedUsd may exceed."},"aiInfluencedMarketUsd":{"type":"number","description":"The counted lines' AI-influenced market: what influencedUsd is a share of."},"influenceableUsd":{"type":"number","description":"Revenue influenced at a 100% win rate on the counted lines: what influencedUsd is a share of."},"influencedUsd":{"anyOf":[{"type":"number"},{"type":"null"}]},"experienceUsd":{"anyOf":[{"type":"number"},{"type":"null"}]},"experienceAiInfluencedSalesUsd":{"type":"number","description":"AI-influenced sales of the lines counted in experienceUsd, each where the product lives. Zero when no line has Experience dollars."},"valuedLineCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"lineCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"measuredLineCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct products (revenue lines) a current Discovery run measured that day, with or without market assumptions in Tools › Products; above valuedLineCount when measured lines lack them."},"experienceValuedLineCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Products (revenue lines) with Experience dollars, of lineCount."}},"required":["aiInfluencedSalesUsd","aiInfluencedMarketUsd","influenceableUsd","influencedUsd","experienceUsd","experienceAiInfluencedSalesUsd","valuedLineCount","lineCount","measuredLineCount","experienceValuedLineCount"],"additionalProperties":false},"BusinessItemTotals":{"type":"object","properties":{"worthUsd":{"type":"number","description":"The counted lines' AI-influenced market."},"influencedUsd":{"anyOf":[{"type":"number"},{"type":"null"}]},"valuedLineCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"lineCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"measuredLineCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Distinct products (revenue lines) a current Discovery run measured that day, with or without market assumptions in Tools › Products; above valuedLineCount when measured lines lack them."},"experienceUsd":{"anyOf":[{"type":"number"},{"type":"null"}]},"experienceWorthUsd":{"type":"number","description":"The AI-influenced market of the lines counted in experienceUsd, each where the product lives. Zero when no line has Experience dollars."},"experienceValuedLineCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Products (revenue lines) with Experience dollars, of lineCount."}},"required":["worthUsd","influencedUsd","valuedLineCount","lineCount","measuredLineCount","experienceUsd","experienceWorthUsd","experienceValuedLineCount"],"additionalProperties":false},"BusinessDataItem":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"profileName":{"type":"string"},"metric":{"type":"string","enum":["discovery_brand_win_rate","discovery_brand_share","experience_pass_rate","inspector_score","google_ads_quality_score"]},"metricLabel":{"type":"string"},"product":{"type":"string"},"unit":{"type":"string","enum":["percent","score","quality_score"]},"min":{"type":"number"},"max":{"type":"number"},"campaignId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"googleAdsAccountId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"subjectLabel":{"type":"string"},"targetValue":{"type":"number"},"dueOn":{"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]},"baselineValue":{"anyOf":[{"type":"number"},{"type":"null"}]},"baselineReadAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"current":{"anyOf":[{"type":"object","properties":{"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"low":{"anyOf":[{"type":"number"},{"type":"null"}]},"high":{"anyOf":[{"type":"number"},{"type":"null"}]},"readAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"caption":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the reading stands on, in its owner's words, shown beside it; null where the owner states none, as every metric's owner does now"}},"required":["value","low","high","readAt","caption"],"additionalProperties":false},{"type":"null"}]},"status":{"type":"string","enum":["no_reading","reached","on_track","within_margin","behind","below_target","missed","stale"]},"paceValue":{"anyOf":[{"type":"number"},{"type":"null"}]},"gapClosedPct":{"anyOf":[{"type":"number"},{"type":"null"}]},"daysLeft":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"targetWorthUsd":{"anyOf":[{"type":"number"},{"type":"null"}]},"series":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","description":"A short display label for the point's day: \"Sep 27\", or \"09-27\" for a Google Ads Quality Score"},"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"The point's UTC day, YYYY-MM-DD"},"value":{"type":"number"}},"required":["label","day","value"],"additionalProperties":false}},"seriesBreaks":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"The UTC day the change was first measured, YYYY-MM-DD"},"label":{"type":"string","description":"Every change that day, in the owner's words"}},"required":["day","label"],"additionalProperties":false},"description":"Days from which the metric's owner measured it differently (for Journey pass rate, a scorer, shopper, model plan or browser change), one a day, oldest first: each a rule the trend draws. Empty for a metric whose owner states none."},"archivedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["id","businessProfileId","profileName","metric","metricLabel","product","unit","min","max","campaignId","googleAdsAccountId","subjectLabel","targetValue","dueOn","baselineValue","baselineReadAt","current","status","paceValue","gapClosedPct","daysLeft","targetWorthUsd","series","seriesBreaks","archivedAt","revision","createdAt","updatedAt"],"additionalProperties":false},"BusinessSources":{"type":"array","items":{"$ref":"#/components/schemas/BusinessItem"}},"BusinessItem":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"kind":{"type":"string","enum":["ga4_property","vercel_project"]},"externalId":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"parentName":{"anyOf":[{"type":"string"},{"type":"null"}]},"currencyCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","enum":["available","selected","access_lost"]},"syncedThrough":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastCheckAttemptAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastCheckErrorCode":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","connectionId","kind","externalId","name","parentName","currencyCode","status","syncedThrough","lastCheckAttemptAt","lastCheckErrorCode"],"additionalProperties":false},"BusinessSources2":{"type":"array","items":{"$ref":"#/components/schemas/BusinessItem2"}},"BusinessItem2":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"kind":{"type":"string","enum":["ga4_property","vercel_project","shopify_shop"]},"externalId":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"parentName":{"anyOf":[{"type":"string"},{"type":"null"}]},"currencyCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","enum":["available","selected","access_lost"]},"syncedThrough":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastCheckAttemptAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastCheckErrorCode":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","connectionId","kind","externalId","name","parentName","currencyCode","status","syncedThrough","lastCheckAttemptAt","lastCheckErrorCode"],"additionalProperties":false},"BusinessChanges":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"status":{"type":"string","enum":["measured","too_few_visits","no_comparison","not_connected","too_early"]},"before":{"anyOf":[{"type":"object","properties":{"from":{"type":"string"},"through":{"type":"string"}},"required":["from","through"],"additionalProperties":false},{"type":"null"}]},"after":{"anyOf":[{"type":"object","properties":{"from":{"type":"string"},"through":{"type":"string"}},"required":["from","through"],"additionalProperties":false},{"type":"null"}]},"changed":{"anyOf":[{"type":"object","properties":{"before":{"type":"number"},"after":{"type":"number"}},"required":["before","after"],"additionalProperties":false},{"type":"null"}]},"rest":{"anyOf":[{"type":"object","properties":{"before":{"type":"number"},"after":{"type":"number"}},"required":["before","after"],"additionalProperties":false},{"type":"null"}]},"changePct":{"anyOf":[{"type":"number"},{"type":"null"}]},"lowPct":{"anyOf":[{"type":"number"},{"type":"null"}]},"highPct":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["key","status","before","after","changed","rest","changePct","lowPct","highPct"],"additionalProperties":false}},"BusinessEdits":{"description":"Answered with includeEditable: the page's customers as an edit takes them","type":"object","properties":{"customers":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"The current version, which an edit names as expectedVersion"},"buyerType":{"anyOf":[{"type":"string","enum":["consumer","organization"]},{"type":"null"}]},"editable":{"$ref":"#/components/schemas/BusinessEditable"},"options":{"type":"string","description":"The key of this customer's options in bucketOptions"}},"required":["id","version","buyerType","editable","options"],"additionalProperties":false}},"bucketOptions":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/BusinessBucketOptions"},"description":"Each category's options and each banded attribute's bands, once per profile that names the page's customers' buckets, by the key its customers name; an attribute a customer's buyer type lacks is absent from its editable fields"}},"required":["customers","bucketOptions"],"additionalProperties":false},"BusinessEditable":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"gender":{"anyOf":[{"type":"string"},{"type":"null"}]},"age":{"type":"object","properties":{"value":{"anyOf":[{"type":"string"},{"type":"null"}]},"band":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["value","band"],"additionalProperties":false},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"location":{"type":"object","properties":{"countryCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"subdivisionCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"locality":{"anyOf":[{"type":"string"},{"type":"null"}]},"postalCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"subdivision":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["countryCode","subdivisionCode","locality","postalCode","country","subdivision"],"additionalProperties":false},"market":{"anyOf":[{"type":"string"},{"type":"null"}]},"areaType":{"anyOf":[{"type":"string"},{"type":"null"}]},"education":{"anyOf":[{"type":"string"},{"type":"null"}]},"lifeStage":{"anyOf":[{"type":"string"},{"type":"null"}]},"household":{"anyOf":[{"type":"object","properties":{"adults":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"children":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"pets":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["adults","children","pets"],"additionalProperties":false},{"type":"null"}]},"householdIncome":{"type":"object","properties":{"value":{"anyOf":[{"type":"string"},{"type":"null"}]},"band":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["value","band"],"additionalProperties":false},"jobTitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"occupation":{"anyOf":[{"type":"string"},{"type":"null"}]},"seniority":{"anyOf":[{"type":"string"},{"type":"null"}]},"employer":{"anyOf":[{"type":"string"},{"type":"null"}]},"yearsInRole":{"anyOf":[{"type":"string"},{"type":"null"}]},"companySize":{"type":"object","properties":{"value":{"anyOf":[{"type":"string"},{"type":"null"}]},"band":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["value","band"],"additionalProperties":false},"annualRevenue":{"anyOf":[{"type":"string"},{"type":"null"}]},"audience":{"anyOf":[{"type":"string"},{"type":"null"}]},"product":{"anyOf":[{"type":"string"},{"type":"null"}]},"channel":{"anyOf":[{"type":"string"},{"type":"null"}]},"buyerRole":{"anyOf":[{"type":"string"},{"type":"null"}]},"stakeholders":{"anyOf":[{"type":"string"},{"type":"null"}]},"intentStage":{"anyOf":[{"type":"string"},{"type":"null"}]},"budget":{"anyOf":[{"type":"string"},{"type":"null"}]},"constraints":{"anyOf":[{"type":"string"},{"type":"null"}]},"job":{"anyOf":[{"type":"string"},{"type":"null"}]},"situation":{"anyOf":[{"type":"string"},{"type":"null"}]},"triggerType":{"anyOf":[{"type":"string"},{"type":"null"}]},"trigger":{"anyOf":[{"type":"string"},{"type":"null"}]},"functionalNeed":{"anyOf":[{"type":"string"},{"type":"null"}]},"emotionalNeed":{"anyOf":[{"type":"string"},{"type":"null"}]},"socialNeed":{"anyOf":[{"type":"string"},{"type":"null"}]},"desiredOutcome":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["name","gender","age","language","location","market","areaType","education","jobTitle","employer","yearsInRole","audience","product","channel","buyerRole","stakeholders","intentStage","budget","constraints","job","situation","triggerType","trigger","functionalNeed","emotionalNeed","socialNeed","desiredOutcome"],"additionalProperties":false,"description":"The fields as business_customers_update_v4 edits them: a category as its id, a banded attribute as its value and band id, the household as its counts, the place as its codes and names"},"BusinessBucketOptions":{"type":"object","properties":{"gender":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"memberAdded":{"type":"boolean","description":"A value a member added for this business profile (with newValues), not one of its profile's or the fixed list's"},"audienceType":{"description":"An audience option's buying entity as its profile declares it: b2b (an organization, whose employer facts apply) or b2c (a household, whose occupation applies); null when it declares neither, absent on every other field","anyOf":[{"type":"string","enum":["b2b","b2c","prosumer","mixed"]},{"type":"null"}]}},"required":["id","label","memberAdded"],"additionalProperties":false}},"age":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"memberAdded":{"type":"boolean","description":"A value a member added for this business profile (with newValues), not one of its profile's or the fixed list's"},"audienceType":{"description":"An audience option's buying entity as its profile declares it: b2b (an organization, whose employer facts apply) or b2c (a household, whose occupation applies); null when it declares neither, absent on every other field","anyOf":[{"type":"string","enum":["b2b","b2c","prosumer","mixed"]},{"type":"null"}]}},"required":["id","label","memberAdded"],"additionalProperties":false}},"language":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"memberAdded":{"type":"boolean","description":"A value a member added for this business profile (with newValues), not one of its profile's or the fixed list's"},"audienceType":{"description":"An audience option's buying entity as its profile declares it: b2b (an organization, whose employer facts apply) or b2c (a household, whose occupation applies); null when it declares neither, absent on every other field","anyOf":[{"type":"string","enum":["b2b","b2c","prosumer","mixed"]},{"type":"null"}]}},"required":["id","label","memberAdded"],"additionalProperties":false}},"market":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"memberAdded":{"type":"boolean","description":"A value a member added for this business profile (with newValues), not one of its profile's or the fixed list's"},"audienceType":{"description":"An audience option's buying entity as its profile declares it: b2b (an organization, whose employer facts apply) or b2c (a household, whose occupation applies); null when it declares neither, absent on every other field","anyOf":[{"type":"string","enum":["b2b","b2c","prosumer","mixed"]},{"type":"null"}]}},"required":["id","label","memberAdded"],"additionalProperties":false}},"areaType":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"memberAdded":{"type":"boolean","description":"A value a member added for this business profile (with newValues), not one of its profile's or the fixed list's"},"audienceType":{"description":"An audience option's buying entity as its profile declares it: b2b (an organization, whose employer facts apply) or b2c (a household, whose occupation applies); null when it declares neither, absent on every other field","anyOf":[{"type":"string","enum":["b2b","b2c","prosumer","mixed"]},{"type":"null"}]}},"required":["id","label","memberAdded"],"additionalProperties":false}},"education":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"memberAdded":{"type":"boolean","description":"A value a member added for this business profile (with newValues), not one of its profile's or the fixed list's"},"audienceType":{"description":"An audience option's buying entity as its profile declares it: b2b (an organization, whose employer facts apply) or b2c (a household, whose occupation applies); null when it declares neither, absent on every other field","anyOf":[{"type":"string","enum":["b2b","b2c","prosumer","mixed"]},{"type":"null"}]}},"required":["id","label","memberAdded"],"additionalProperties":false}},"lifeStage":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"memberAdded":{"type":"boolean","description":"A value a member added for this business profile (with newValues), not one of its profile's or the fixed list's"},"audienceType":{"description":"An audience option's buying entity as its profile declares it: b2b (an organization, whose employer facts apply) or b2c (a household, whose occupation applies); null when it declares neither, absent on every other field","anyOf":[{"type":"string","enum":["b2b","b2c","prosumer","mixed"]},{"type":"null"}]}},"required":["id","label","memberAdded"],"additionalProperties":false}},"householdIncome":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"memberAdded":{"type":"boolean","description":"A value a member added for this business profile (with newValues), not one of its profile's or the fixed list's"},"audienceType":{"description":"An audience option's buying entity as its profile declares it: b2b (an organization, whose employer facts apply) or b2c (a household, whose occupation applies); null when it declares neither, absent on every other field","anyOf":[{"type":"string","enum":["b2b","b2c","prosumer","mixed"]},{"type":"null"}]}},"required":["id","label","memberAdded"],"additionalProperties":false}},"occupation":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"memberAdded":{"type":"boolean","description":"A value a member added for this business profile (with newValues), not one of its profile's or the fixed list's"},"audienceType":{"description":"An audience option's buying entity as its profile declares it: b2b (an organization, whose employer facts apply) or b2c (a household, whose occupation applies); null when it declares neither, absent on every other field","anyOf":[{"type":"string","enum":["b2b","b2c","prosumer","mixed"]},{"type":"null"}]}},"required":["id","label","memberAdded"],"additionalProperties":false}},"seniority":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"memberAdded":{"type":"boolean","description":"A value a member added for this business profile (with newValues), not one of its profile's or the fixed list's"},"audienceType":{"description":"An audience option's buying entity as its profile declares it: b2b (an organization, whose employer facts apply) or b2c (a household, whose occupation applies); null when it declares neither, absent on every other field","anyOf":[{"type":"string","enum":["b2b","b2c","prosumer","mixed"]},{"type":"null"}]}},"required":["id","label","memberAdded"],"additionalProperties":false}},"companySize":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"memberAdded":{"type":"boolean","description":"A value a member added for this business profile (with newValues), not one of its profile's or the fixed list's"},"audienceType":{"description":"An audience option's buying entity as its profile declares it: b2b (an organization, whose employer facts apply) or b2c (a household, whose occupation applies); null when it declares neither, absent on every other field","anyOf":[{"type":"string","enum":["b2b","b2c","prosumer","mixed"]},{"type":"null"}]}},"required":["id","label","memberAdded"],"additionalProperties":false}},"audience":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"memberAdded":{"type":"boolean","description":"A value a member added for this business profile (with newValues), not one of its profile's or the fixed list's"},"audienceType":{"description":"An audience option's buying entity as its profile declares it: b2b (an organization, whose employer facts apply) or b2c (a household, whose occupation applies); null when it declares neither, absent on every other field","anyOf":[{"type":"string","enum":["b2b","b2c","prosumer","mixed"]},{"type":"null"}]}},"required":["id","label","memberAdded"],"additionalProperties":false}},"product":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"memberAdded":{"type":"boolean","description":"A value a member added for this business profile (with newValues), not one of its profile's or the fixed list's"},"audienceType":{"description":"An audience option's buying entity as its profile declares it: b2b (an organization, whose employer facts apply) or b2c (a household, whose occupation applies); null when it declares neither, absent on every other field","anyOf":[{"type":"string","enum":["b2b","b2c","prosumer","mixed"]},{"type":"null"}]}},"required":["id","label","memberAdded"],"additionalProperties":false}},"channel":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"memberAdded":{"type":"boolean","description":"A value a member added for this business profile (with newValues), not one of its profile's or the fixed list's"},"audienceType":{"description":"An audience option's buying entity as its profile declares it: b2b (an organization, whose employer facts apply) or b2c (a household, whose occupation applies); null when it declares neither, absent on every other field","anyOf":[{"type":"string","enum":["b2b","b2c","prosumer","mixed"]},{"type":"null"}]}},"required":["id","label","memberAdded"],"additionalProperties":false}},"buyerRole":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"memberAdded":{"type":"boolean","description":"A value a member added for this business profile (with newValues), not one of its profile's or the fixed list's"},"audienceType":{"description":"An audience option's buying entity as its profile declares it: b2b (an organization, whose employer facts apply) or b2c (a household, whose occupation applies); null when it declares neither, absent on every other field","anyOf":[{"type":"string","enum":["b2b","b2c","prosumer","mixed"]},{"type":"null"}]}},"required":["id","label","memberAdded"],"additionalProperties":false}},"intentStage":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"memberAdded":{"type":"boolean","description":"A value a member added for this business profile (with newValues), not one of its profile's or the fixed list's"},"audienceType":{"description":"An audience option's buying entity as its profile declares it: b2b (an organization, whose employer facts apply) or b2c (a household, whose occupation applies); null when it declares neither, absent on every other field","anyOf":[{"type":"string","enum":["b2b","b2c","prosumer","mixed"]},{"type":"null"}]}},"required":["id","label","memberAdded"],"additionalProperties":false}},"job":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"memberAdded":{"type":"boolean","description":"A value a member added for this business profile (with newValues), not one of its profile's or the fixed list's"},"audienceType":{"description":"An audience option's buying entity as its profile declares it: b2b (an organization, whose employer facts apply) or b2c (a household, whose occupation applies); null when it declares neither, absent on every other field","anyOf":[{"type":"string","enum":["b2b","b2c","prosumer","mixed"]},{"type":"null"}]}},"required":["id","label","memberAdded"],"additionalProperties":false}},"triggerType":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"memberAdded":{"type":"boolean","description":"A value a member added for this business profile (with newValues), not one of its profile's or the fixed list's"},"audienceType":{"description":"An audience option's buying entity as its profile declares it: b2b (an organization, whose employer facts apply) or b2c (a household, whose occupation applies); null when it declares neither, absent on every other field","anyOf":[{"type":"string","enum":["b2b","b2c","prosumer","mixed"]},{"type":"null"}]}},"required":["id","label","memberAdded"],"additionalProperties":false}}},"required":["gender","age","language","market","areaType","education","audience","product","channel","buyerRole","intentStage","job","triggerType"],"additionalProperties":false,"description":"Each category's options for this customer, and each banded attribute's bands: a fixed list whole, an open category's profile options then the values members added for its business profile; the ids business_customers_update_v4 takes"},"BusinessLatestActivity":{"type":"object","properties":{"product":{"type":"string","enum":["experience","research"]},"id":{"type":"string"},"campaignId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"occurredAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"label":{"type":"string"},"status":{"anyOf":[{"type":"string","enum":["scheduled","waiting","running","completed","failed","cancelled"]},{"type":"null"}]}},"required":["product","id","campaignId","occurredAt","label","status"],"additionalProperties":false},"BusinessPersona":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name: The person's name. There is one name; there is no separate display name."},"gender":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the customer's profile calls it; null when nothing names it"}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Gender: Their gender."},"age":{"type":"object","properties":{"value":{"anyOf":[{"type":"string"},{"type":"null"}]},"band":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the customer's profile calls it; null when nothing names it"}},"required":["id","label"],"additionalProperties":false},{"type":"null"}]}},"required":["value","band"],"additionalProperties":false,"description":"Age: Their age in years, with its band beside it."},"language":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the customer's profile calls it; null when nothing names it"}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Language: The language they use with an assistant."},"location":{"type":"object","properties":{"countryCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"subdivisionCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"locality":{"anyOf":[{"type":"string"},{"type":"null"}]},"postalCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"street":{"anyOf":[{"type":"string"},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"coordinateSource":{"anyOf":[{"type":"string","enum":["source","derived_descendants","unavailable","street_address"]},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"subdivision":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["countryCode","subdivisionCode","locality","postalCode","street","latitude","longitude","coordinateSource","country","subdivision","label"],"additionalProperties":false,"description":"Location: Where they live. An address, not a segment. Place names print from the codes."},"market":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the customer's profile calls it; null when nothing names it"}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Market: The Profile market they were planned in. A segment, not an address."},"areaType":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the customer's profile calls it; null when nothing names it"}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Area type: Urban core, suburban, town or rural."},"education":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the customer's profile calls it; null when nothing names it"}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Education: The highest level they completed."},"lifeStage":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the customer's profile calls it; null when nothing names it"}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Life stage: Where they are in life, student through retired."},"household":{"anyOf":[{"type":"object","properties":{"adults":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"children":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"pets":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["adults","children","pets"],"additionalProperties":false},{"type":"null"}],"description":"Household: Who they live with."},"householdIncome":{"type":"object","properties":{"value":{"anyOf":[{"type":"string"},{"type":"null"}]},"band":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the customer's profile calls it; null when nothing names it"}},"required":["id","label"],"additionalProperties":false},{"type":"null"}]}},"required":["value","band"],"additionalProperties":false,"description":"Household income: The household's yearly income."},"jobTitle":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Job title: Their actual job. Not their role in the purchase."},"occupation":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the customer's profile calls it; null when nothing names it"}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Occupation: The category of a consumer's job title."},"seniority":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the customer's profile calls it; null when nothing names it"}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Seniority: The level of a business buyer's job title."},"employer":{"type":"object","properties":{"value":{"anyOf":[{"type":"string"},{"type":"null"}]},"link":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["value","link"],"additionalProperties":false,"description":"Employer: Where they work."},"yearsInRole":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Years in role: How long they have held the job title."},"companySize":{"type":"object","properties":{"value":{"anyOf":[{"type":"string"},{"type":"null"}]},"band":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the customer's profile calls it; null when nothing names it"}},"required":["id","label"],"additionalProperties":false},{"type":"null"}]}},"required":["value","band"],"additionalProperties":false,"description":"Company size: Their organization's employee count. Not its revenue (Annual revenue)."},"annualRevenue":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Annual revenue: Their organization's yearly revenue."},"buyerType":{"anyOf":[{"type":"string","enum":["consumer","organization"]},{"type":"null"}],"description":"Buyer type: Who is buying: a person or household, or an organization. It decides which attributes apply."},"audience":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the customer's profile calls it; null when nothing names it"}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Audience: The Profile audience they belong to."},"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the customer's profile calls it; null when nothing names it"}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Product: The product they would buy."},"channel":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the customer's profile calls it; null when nothing names it"}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Channel: Where they buy it."},"buyerRole":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the customer's profile calls it; null when nothing names it"}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Buyer role: Their own part in the decision, such as decider or influencer. Not anyone else in the decision (Stakeholders)."},"stakeholders":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Stakeholders: Everyone else in the decision, and their stance."},"intentStage":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the customer's profile calls it; null when nothing names it"}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Intent stage: Awareness, consideration or decision."},"budget":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Budget: What they can spend, and how price-sensitive they are. Not a hard limit."},"constraints":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Constraints: Hard limits that can block the purchase. Budget appears here only when it is a hard limit."},"job":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the customer's profile calls it; null when nothing names it"}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Job to be done: The Profile's category of progress they are after. Not how they want to feel (Emotional need) or be seen (Social need), nor how they will judge success (Desired outcome)."},"situation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Situation: Their circumstances today: the steady state."},"triggerType":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the customer's profile calls it; null when nothing names it"}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Trigger type: The category of the trigger."},"trigger":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Trigger: What changed that started them looking now."},"functionalNeed":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Functional need: What they are trying to get done, in their own words."},"emotionalNeed":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Emotional need: How they want to feel."},"socialNeed":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Social need: How they want to be seen."},"desiredOutcome":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Desired outcome: How they will judge success once it is done. Not the progress they are after (Job to be done)."},"labels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"}},"required":["id","label"],"additionalProperties":false},"description":"Labels: The lists a member put them on."}},"required":["name","gender","age","language","location","market","areaType","education","jobTitle","employer","yearsInRole","buyerType","audience","product","channel","buyerRole","stakeholders","intentStage","budget","constraints","job","situation","triggerType","trigger","functionalNeed","emotionalNeed","socialNeed","desiredOutcome","labels"],"additionalProperties":false,"description":"The customer's current version under the customer model's keys, in its order. An attribute only consumers or only organizations have is absent for the other buyer type."},"BusinessPins":{"anyOf":[{"type":"object","properties":{"provider":{"type":"string","enum":["hubspot","salesforce"]},"pins":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"field":{"type":"string","enum":["name","gender","age","language","location","market","areaType","education","lifeStage","household","householdIncome","jobTitle","occupation","seniority","employer","yearsInRole","companySize","annualRevenue","audience","product","channel","buyerRole","stakeholders","intentStage","budget","constraints","job","situation","triggerType","trigger","functionalNeed","emotionalNeed","socialNeed","desiredOutcome"]},"pinnedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"review":{"anyOf":[{"type":"object","properties":{"refreshId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"raisedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"crmValue":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["refreshId","raisedAt","crmValue"],"additionalProperties":false},{"type":"null"}]}},"required":["id","field","pinnedAt","review"],"additionalProperties":false}}},"required":["provider","pins"],"additionalProperties":false},{"type":"null"}]},"BusinessSkipped":{"type":"array","items":{"type":"object","properties":{"campaignId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"product":{"type":"string","enum":["discovery","research","experience"]},"reason":{"type":"string","description":"Why it takes no rerun: campaign_paused, campaign_held, one_time, pulse, point11_campaign or not_started; or Billing's refusal reason (such as no_subscription, billing_suspended or interaction_unavailable) when Billing would not admit the product's reruns"},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Billing's own sentence for the member when Billing refused the product's reruns; null for every other reason"},"paymentDisputeHold":{"description":"Present when Billing refused because the account is on hold while a payment dispute is reviewed: offer support, not a payment method update","type":"boolean","const":true}},"required":["campaignId","product","reason","message"],"additionalProperties":false},"description":"Campaigns an edited customer is in that take no rerun"},"BusinessImpact":{"type":"object","properties":{"selectedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"foundCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"customers":{"type":"array","items":{"type":"object","properties":{"customerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"discovery":{"type":"object","properties":{"activeExecutionCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"futureMembershipCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"historicalReferenceCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["activeExecutionCount","futureMembershipCount","historicalReferenceCount"],"additionalProperties":false},"research":{"type":"object","properties":{"activeExecutionCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"futureMembershipCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"historicalReferenceCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["activeExecutionCount","futureMembershipCount","historicalReferenceCount"],"additionalProperties":false},"experience":{"type":"object","properties":{"activeExecutionCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"futureMembershipCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"historicalReferenceCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["activeExecutionCount","futureMembershipCount","historicalReferenceCount"],"additionalProperties":false},"activeExecution":{"type":"boolean"},"futureMembership":{"type":"boolean"},"historicalReference":{"type":"boolean"}},"required":["customerId","discovery","research","experience","activeExecution","futureMembership","historicalReference"],"additionalProperties":false}},"totals":{"type":"object","properties":{"activeExecutionCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"futureMembershipCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"historicalReferenceCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["activeExecutionCount","futureMembershipCount","historicalReferenceCount"],"additionalProperties":false}},"required":["selectedCount","foundCount","customers","totals"],"additionalProperties":false},"BusinessModel":{"type":"object","properties":{"dimensions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","enum":["job_mix","audience_mix","channel_mix","revenue_mix","intent_stage_mix","age_mix","gender_mix","education_mix","household_income_mix","urbanicity_mix","regional_mix","life_stage_mix","language_mix","occupation_mix","company_size_mix","buyer_role_mix"]},"label":{"type":"string"},"buckets":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"bucketIds":{"type":"array","items":{"type":"string"}},"catalogIds":{"type":"array","items":{"type":"string"}},"customerCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"displayOrder":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["label","bucketIds","catalogIds","customerCount","displayOrder"],"additionalProperties":false}},"assignedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"unmodeledCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"absentFromProfile":{"type":"boolean"}},"required":["id","label","buckets","assignedCount","unmodeledCount","absentFromProfile"],"additionalProperties":false}},"geography":{"type":"object","properties":{"nodes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"parentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"childIds":{"type":"array","items":{"type":"string"}},"level":{"type":"string","enum":["country","admin1","postal"]},"label":{"type":"string"},"regionCode":{"type":"string"},"resolution":{"type":"string","enum":["countries","provinces","postal"]},"countryCode":{"type":"string"},"admin1Code":{"anyOf":[{"type":"string"},{"type":"null"}]},"subdivisionCodes":{"type":"array","items":{"type":"string"}},"displayName":{"anyOf":[{"type":"string"},{"type":"null"}]},"customerCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["id","parentId","childIds","level","label","regionCode","resolution","countryCode","admin1Code","subdivisionCodes","displayName","customerCount"],"additionalProperties":false}},"totalCustomerCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["nodes","totalCustomerCount"],"additionalProperties":false},"activeCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"retiredCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"audienceType":{"anyOf":[{"type":"string","enum":["b2b","b2c","prosumer","mixed"]},{"type":"null"}]}},"required":["dimensions","geography","activeCount","retiredCount","audienceType"],"additionalProperties":false},"BusinessScoring":{"anyOf":[{"type":"object","properties":{"brands":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"color":{"anyOf":[{"type":"string"},{"type":"null"}]},"role":{"anyOf":[{"type":"string","enum":["target","competitor","other"]},{"type":"null"}]},"outcome":{"anyOf":[{"type":"string","enum":["winner","mentioned","not-mentioned"]},{"type":"null"}]},"position":{"anyOf":[{"type":"number"},{"type":"null"}]},"sentiment":{"anyOf":[{"type":"string","enum":["positive","neutral","mixed","negative"]},{"type":"null"}]},"mentionCount":{"anyOf":[{"type":"number"},{"type":"null"}]},"summary":{"anyOf":[{"type":"string"},{"type":"null"}]},"aliases":{"type":"array","items":{"type":"string"}},"positivePhrases":{"type":"array","items":{"type":"string"}},"negativePhrases":{"type":"array","items":{"type":"string"}}},"required":["id","name"],"additionalProperties":false}}},"required":["brands"],"additionalProperties":false},{"type":"null"}]},"BusinessBrandMentions":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"color":{"anyOf":[{"type":"string"},{"type":"null"}]},"role":{"anyOf":[{"type":"string","enum":["target","competitor","other"]},{"type":"null"}]},"outcome":{"anyOf":[{"type":"string","enum":["winner","mentioned","not-mentioned"]},{"type":"null"}]},"sentiment":{"anyOf":[{"type":"string","enum":["positive","neutral","mixed","negative"]},{"type":"null"}]},"mentionCount":{"anyOf":[{"type":"number"},{"type":"null"}]},"faviconUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The brand's own favicon; null when its campaign resolved none."},"faviconTone":{"type":"string","enum":["dark","light","mixed","unknown"]},"faviconTransparent":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"faviconNeedsLightBackplate":{"type":"boolean"},"faviconNeedsDarkBackplate":{"type":"boolean"}},"required":["name","color","role","outcome","sentiment","mentionCount","faviconUrl","faviconTone","faviconTransparent","faviconNeedsLightBackplate","faviconNeedsDarkBackplate"],"additionalProperties":false}},"BusinessMostImportantCitation":{"anyOf":[{"type":"object","properties":{"url":{"type":"string"},"label":{"type":"string"},"influenceWeightPct":{"anyOf":[{"type":"number"},{"type":"null"}]},"influenceKind":{"anyOf":[{"type":"string"},{"type":"null"}]},"rationale":{"anyOf":[{"type":"string"},{"type":"null"}]},"faviconUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The cited site's favicon; null when its source identity resolved none."},"faviconTone":{"type":"string","enum":["dark","light","mixed","unknown"]},"faviconTransparent":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"faviconNeedsLightBackplate":{"type":"boolean"},"faviconNeedsDarkBackplate":{"type":"boolean"}},"required":["url","label","influenceWeightPct","influenceKind","rationale","faviconUrl","faviconTone","faviconTransparent","faviconNeedsLightBackplate","faviconNeedsDarkBackplate"],"additionalProperties":false},{"type":"null"}]},"BusinessPositiveSentiment":{"type":"array","items":{"type":"object","properties":{"brand":{"type":"string"},"phrase":{"type":"string"},"faviconUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The brand's own favicon; null when its campaign resolved none."},"faviconTone":{"type":"string","enum":["dark","light","mixed","unknown"]},"faviconTransparent":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"faviconNeedsLightBackplate":{"type":"boolean"},"faviconNeedsDarkBackplate":{"type":"boolean"},"source":{"anyOf":[{"type":"object","properties":{"url":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"type":"string"},"faviconUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"faviconLightUrl":{"description":"Never sent: a source's favicon is one image for both themes, faviconUrl.","type":"null"},"faviconDarkUrl":{"description":"Never sent: a source's favicon is one image for both themes, faviconUrl.","type":"null"},"faviconTone":{"anyOf":[{"type":"string","enum":["dark","light","mixed","unknown"]},{"type":"null"}]},"faviconTransparent":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"faviconNeedsLightBackplate":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"faviconNeedsDarkBackplate":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["url","label","faviconUrl"],"additionalProperties":false},{"type":"null"}]}},"required":["brand","phrase","faviconUrl","faviconTone","faviconTransparent","faviconNeedsLightBackplate","faviconNeedsDarkBackplate"],"additionalProperties":false}},"BusinessOutcomeSummaryPositiveSentiment":{"type":"array","items":{"type":"object","properties":{"brand":{"type":"string"},"phrase":{"type":"string"},"faviconUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The brand's own favicon; null when its campaign resolved none."},"faviconTone":{"type":"string","enum":["dark","light","mixed","unknown"]},"faviconTransparent":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"faviconNeedsLightBackplate":{"type":"boolean"},"faviconNeedsDarkBackplate":{"type":"boolean"},"source":{"anyOf":[{"type":"object","properties":{"url":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"type":"string"},"faviconUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"faviconTone":{"anyOf":[{"type":"string","enum":["dark","light","mixed","unknown"]},{"type":"null"}]},"faviconTransparent":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"faviconNeedsLightBackplate":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"faviconNeedsDarkBackplate":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["url","label","faviconUrl"],"additionalProperties":false},{"type":"null"}]}},"required":["brand","phrase","faviconUrl","faviconTone","faviconTransparent","faviconNeedsLightBackplate","faviconNeedsDarkBackplate"],"additionalProperties":false}},"BusinessCard":{"anyOf":[{"type":"object","properties":{"version":{"type":"number","const":3},"baseGenerationProfileId":{"type":"string"},"baseSourceHash":{"type":"string"},"profileName":{"type":"string"},"overrides":{"type":"object","propertyNames":{"type":"string","enum":["job_mix","trigger_type_mix","audience_mix","channel_mix","revenue_mix","intent_stage_mix","age_mix","gender_mix","education_mix","household_income_mix","urbanicity_mix","regional_mix","life_stage_mix","language_mix","occupation_mix","company_size_mix","buyer_role_mix","seniority_mix","job_title_mix","years_in_role_mix"]},"additionalProperties":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"ref"},"id":{"type":"string"},"label":{"type":"string"},"weightPct":{"type":"number"},"purchaseMode":{"type":"string","enum":["on_premises","local_service_area","remote_direct","third_party","sales_led"]}},"required":["kind","id","label","weightPct"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"authored"},"clientKey":{"type":"string"},"label":{"type":"string"},"weightPct":{"type":"number"},"templateId":{"type":"string"},"purchaseMode":{"type":"string","enum":["on_premises","local_service_area","remote_direct","third_party","sales_led"]}},"required":["kind","clientKey","label","weightPct"],"additionalProperties":false}]}}},"employerAccounts":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"domain":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["name","domain"],"additionalProperties":false}},"givenFacts":{"$ref":"#/components/schemas/DiscoveryGivenFacts"}},"required":["version","baseGenerationProfileId","baseSourceHash","profileName","overrides"],"additionalProperties":false},{"type":"null"}]},"BusinessReview":{"type":"array","items":{"type":"object","properties":{"dimensionId":{"type":"string","enum":["job_mix","trigger_type_mix","audience_mix","channel_mix","revenue_mix","intent_stage_mix","age_mix","gender_mix","education_mix","household_income_mix","urbanicity_mix","regional_mix","life_stage_mix","language_mix","occupation_mix","company_size_mix","buyer_role_mix","seniority_mix","job_title_mix","years_in_role_mix"]},"label":{"type":"string"},"outcome":{"type":"string","enum":["mapped","new","inherited"]},"selections":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"weightPct":{"type":"number"},"kind":{"type":"string","enum":["ref","authored"]},"templateId":{"anyOf":[{"type":"string"},{"type":"null"}]},"purchaseMode":{"anyOf":[{"type":"string","enum":["on_premises","local_service_area","remote_direct","third_party","sales_led"]},{"type":"null"}]},"fit":{"type":"string","enum":["exact","nearest"]},"said":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["label","weightPct","kind","templateId","purchaseMode","fit","said"],"additionalProperties":false}},"phrase":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["dimensionId","label","outcome","selections","phrase"],"additionalProperties":false}},"BusinessProducts":{"anyOf":[{"type":"array","items":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"ref"},"id":{"type":"string"},"label":{"type":"string"},"weightPct":{"type":"number"}},"required":["kind","id","label","weightPct"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"new"},"name":{"type":"string"},"phrase":{"type":"string"},"weightPct":{"type":"number"}},"required":["kind","name","phrase","weightPct"],"additionalProperties":false}]}},{"type":"null"}],"description":"The customers' Product mix when the description names a product the business profile does not have yet (kind new, with the name it gives and the words that name it), each product with its share (weightPct); the card then leaves its revenue mix out. Create each new product with business_revenue_lines_create_v2, then set the card's overrides.revenue_mix to these shares, each product as a ref (a new one by the created revenue line's id and name), and pass that card to business_manual_profiles_create_v2. Null when every product it names is the profile's own"},"BusinessCustomers":{"type":"array","items":{"type":"object","properties":{"customerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"optionSet":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"changes":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["gender","age","age.band","language","location","market","areaType","education","lifeStage","household","householdIncome","householdIncome.band","jobTitle","occupation","seniority","employer","yearsInRole","companySize","companySize.band","annualRevenue","audience","product","channel","buyerRole","stakeholders","intentStage","budget","constraints","job","situation","triggerType","trigger","functionalNeed","emotionalNeed","socialNeed","desiredOutcome"]},"before":{"anyOf":[{"type":"string"},{"type":"null"}]},"after":{"anyOf":[{"type":"string"},{"type":"null"}]},"current":{"$ref":"#/components/schemas/BusinessCurrent"},"proposed":{"$ref":"#/components/schemas/BusinessCurrent"},"follows":{"anyOf":[{"type":"string","enum":["gender","age","age.band","language","location","market","areaType","education","lifeStage","household","householdIncome","householdIncome.band","jobTitle","occupation","seniority","employer","yearsInRole","companySize","companySize.band","annualRevenue","audience","product","channel","buyerRole","stakeholders","intentStage","budget","constraints","job","situation","triggerType","trigger","functionalNeed","emotionalNeed","socialNeed","desiredOutcome"]},{"type":"null"}]},"newValue":{"type":"boolean"},"fit":{"anyOf":[{"type":"string","enum":["exact","nearest"]},{"type":"null"}]},"said":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["field","before","after","current","proposed","follows","newValue","fit","said"],"additionalProperties":false}},"labels":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"said":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["name","said"],"additionalProperties":false}},"businessProfileId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"product":{"anyOf":[{"type":"object","properties":{"before":{"anyOf":[{"type":"string"},{"type":"null"}]},"after":{"type":"string"},"current":{"anyOf":[{"type":"string"},{"type":"null"}]},"proposed":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"product"},"id":{"type":"string"}},"required":["kind","id"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"new_product"},"name":{"type":"string"},"description":{"type":"string"}},"required":["kind","name","description"],"additionalProperties":false}]},"fit":{"type":"string","enum":["exact","nearest"]},"said":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["before","after","current","proposed","fit","said"],"additionalProperties":false},{"type":"null"}]},"buyerType":{"anyOf":[{"type":"string","enum":["consumer","organization"]},{"type":"null"}]},"fields":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["gender","age","age.band","language","location","market","areaType","education","lifeStage","household","householdIncome","householdIncome.band","jobTitle","occupation","seniority","employer","yearsInRole","companySize","companySize.band","annualRevenue","audience","product","channel","buyerRole","stakeholders","intentStage","budget","constraints","job","situation","triggerType","trigger","functionalNeed","emotionalNeed","socialNeed","desiredOutcome"]},"value":{"anyOf":[{"type":"string"},{"type":"null"}]},"current":{"$ref":"#/components/schemas/BusinessCurrent"}},"required":["field","value","current"],"additionalProperties":false}}},"required":["customerId","name","version","optionSet","changes","labels","businessProfileId","product","buyerType","fields"],"additionalProperties":false}},"BusinessCurrent":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"text"},"text":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["kind","text"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"option"},"id":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["kind","id"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"words"},"words":{"type":"string"}},"required":["kind","words"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"place"},"place":{"type":"object","properties":{"countryCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"subdivision":{"anyOf":[{"type":"string"},{"type":"null"}]},"locality":{"anyOf":[{"type":"string"},{"type":"null"}]},"postalCode":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["countryCode","subdivision","locality","postalCode"],"additionalProperties":false}},"required":["kind","place"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"household"},"household":{"anyOf":[{"type":"object","properties":{"adults":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"children":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"pets":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]}},"required":["adults","children","pets"],"additionalProperties":false},{"type":"null"}]}},"required":["kind","household"],"additionalProperties":false}]},"BusinessProfile3":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"hostname":{"type":"string"},"recordStatus":{"type":"string","enum":["active","archived","deleted"]},"forecastRecordStatus":{"anyOf":[{"type":"string","enum":["active","archived","deleted"]},{"type":"null"}]},"profileArtifactAvailable":{"type":"boolean"},"profileLatestAttemptState":{"anyOf":[{"type":"string","enum":["running","succeeded","failed","cancelled","partial"]},{"type":"null"}]},"profileGenerationProgress":{"anyOf":[{"type":"object","properties":{"state":{"type":"string"},"label":{"type":"string"},"takingLonger":{"type":"boolean"},"executionStatus":{"type":"string","enum":["waiting","running"]}},"required":["state","label","takingLonger","executionStatus"],"additionalProperties":false},{"type":"null"}]},"forecastArtifactAvailable":{"type":"boolean"},"forecastLatestAttemptState":{"anyOf":[{"type":"string","enum":["running","succeeded","failed","cancelled","partial"]},{"type":"null"}]},"forecastGenerationProgress":{"anyOf":[{"type":"object","properties":{"state":{"type":"string"},"label":{"type":"string"},"takingLonger":{"type":"boolean"},"executionStatus":{"type":"string","enum":["waiting","running"]}},"required":["state","label","takingLonger","executionStatus"],"additionalProperties":false},{"type":"null"}]},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"providerCount":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"profileQuality":{"type":"string","enum":["complete","limited_evidence"]},"generatedByRunId":{"anyOf":[{"type":"string"},{"type":"null"}]},"forecastGeneratedByRunId":{"anyOf":[{"type":"string"},{"type":"null"}]},"detail":{"anyOf":[{"type":"object","properties":{"hero":{"type":"object","properties":{"about":{"type":"string"},"mission":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}}},"required":["about","mission","tags"],"additionalProperties":false},"facts":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"},"citations":{"type":"array","items":{"type":"string"}}},"required":["label","value","citations"],"additionalProperties":false}},"revenue":{"$ref":"#/components/schemas/BusinessRevenue"},"overview":{"type":"array","items":{"type":"object","properties":{"editPath":{"type":"string"},"leadEditPath":{"type":"string"},"lead":{"type":"string"},"body":{"type":"string"}},"required":["lead","body"],"additionalProperties":false}},"operations":{"type":"object","properties":{"operatingModel":{"type":"array","items":{"type":"object","properties":{"editPath":{"type":"string"},"leadEditPath":{"type":"string"},"lead":{"type":"string"},"body":{"type":"string"}},"required":["lead","body"],"additionalProperties":false}},"costStructure":{"type":"array","items":{"type":"object","properties":{"editPath":{"type":"string"},"leadEditPath":{"type":"string"},"lead":{"type":"string"},"body":{"type":"string"}},"required":["lead","body"],"additionalProperties":false}},"citations":{"type":"object","properties":{"operatingModel":{"type":"array","items":{"type":"string"}},"costStructure":{"type":"array","items":{"type":"string"}}},"required":["operatingModel","costStructure"],"additionalProperties":false}},"required":["operatingModel","costStructure","citations"],"additionalProperties":false},"assets":{"type":"object","properties":{"assetBase":{"type":"array","items":{"type":"object","properties":{"editPath":{"type":"string"},"leadEditPath":{"type":"string"},"lead":{"type":"string"},"body":{"type":"string"}},"required":["lead","body"],"additionalProperties":false}},"citations":{"type":"object","properties":{"assetBase":{"type":"array","items":{"type":"string"}}},"required":["assetBase"],"additionalProperties":false}},"required":["assetBase","citations"],"additionalProperties":false},"leaders":{"type":"array","items":{"type":"object","properties":{"bioEditPath":{"type":"string"},"title":{"type":"string"},"tenureStart":{"anyOf":[{"type":"number"},{"type":"null"}]},"editPath":{"type":"string"},"initials":{"type":"string"},"name":{"type":"string"},"role":{"type":"string"},"bio":{"type":"string"}},"required":["initials","name","role","bio"],"additionalProperties":false}},"ownership":{"$ref":"#/components/schemas/BusinessOwnership"},"financials":{"type":"object","properties":{"actuals":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"},"unit":{"anyOf":[{"type":"string"},{"type":"null"}]},"citations":{"type":"array","items":{"type":"string"}},"meta":{"type":"array","items":{"type":"string"}}},"required":["label","value","unit","citations"],"additionalProperties":false}},"citations":{"type":"object","properties":{"actuals":{"type":"array","items":{"type":"string"}}},"required":["actuals"],"additionalProperties":false}},"required":["actuals","citations"],"additionalProperties":false},"audiences":{"$ref":"#/components/schemas/BusinessAudiences"},"history":{"type":"array","items":{"type":"object","properties":{"editPaths":{"type":"object","properties":{"marker":{"type":"string"},"body":{"type":"string"}},"required":["marker","body"],"additionalProperties":false},"marker":{"type":"string"},"body":{"type":"string"},"major":{"type":"boolean"},"citations":{"type":"array","items":{"type":"string"}}},"required":["marker","body","major","citations"],"additionalProperties":false}},"geography":{"$ref":"#/components/schemas/BusinessGeography"},"channelMix":{"$ref":"#/components/schemas/BusinessChannelMix"},"competitors":{"type":"object","properties":{"descriptor":{"type":"string"},"rows":{"type":"array","items":{"type":"object","properties":{"editPaths":{"type":"object","properties":{"name":{"type":"string"},"overlap":{"type":"array","items":{"type":"string"}},"intensity":{"type":"string"},"trend":{"type":"string"}},"required":["name","overlap"],"additionalProperties":false},"name":{"type":"string"},"note":{"type":"string"},"intensityPct":{"type":"number"},"intensity":{"type":"string"},"overlap":{"type":"string"},"trendDirection":{"type":"number"},"chart":{"anyOf":[{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"series"},"points":{"type":"array","items":{"type":"object","properties":{"month":{"type":"string"},"value":{"type":"number"}},"required":["month","value"],"additionalProperties":false}}},"required":["kind","points"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"snapshot"},"points":{"type":"array","items":{"type":"object","properties":{"month":{"type":"string"},"value":{"type":"number"}},"required":["month","value"],"additionalProperties":false}},"benchmark":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["kind","points"],"additionalProperties":false}]},{"type":"null"}]}},"required":["name","note","intensityPct","intensity","overlap","trendDirection","chart"],"additionalProperties":false}},"kpis":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"},"unit":{"anyOf":[{"type":"string"},{"type":"null"}]},"delta":{"anyOf":[{"type":"object","properties":{"text":{"type":"string"},"direction":{"type":"string","enum":["up","down","neutral"]}},"required":["text","direction"],"additionalProperties":false},{"type":"null"}]},"citations":{"type":"array","items":{"type":"string"}}},"required":["label","value","unit","delta","citations"],"additionalProperties":false}},"battlegrounds":{"type":"array","items":{"type":"object","properties":{"editPath":{"type":"string"},"leadEditPath":{"type":"string"},"lead":{"type":"string"},"body":{"type":"string"}},"required":["lead","body"],"additionalProperties":false}},"citations":{"type":"object","properties":{"descriptor":{"type":"array","items":{"type":"string"}}},"required":["descriptor"],"additionalProperties":false}},"required":["descriptor","rows","kpis","battlegrounds","citations"],"additionalProperties":false},"environment":{"$ref":"#/components/schemas/BusinessEnvironment"},"recentEvents":{"type":"array","items":{"type":"object","properties":{"editPaths":{"type":"object","properties":{"marker":{"type":"string"},"body":{"type":"string"}},"required":["marker","body"],"additionalProperties":false},"marker":{"type":"string"},"body":{"type":"string"},"major":{"type":"boolean"},"citations":{"type":"array","items":{"type":"string"}}},"required":["marker","body","major","citations"],"additionalProperties":false}},"outlook":{"type":"object","properties":{"descriptor":{"type":"string"},"tailwinds":{"type":"array","items":{"type":"object","properties":{"weight":{"type":"string"},"text":{"type":"string"}},"required":["weight","text"],"additionalProperties":false}},"headwinds":{"type":"array","items":{"type":"object","properties":{"weight":{"type":"string"},"text":{"type":"string"}},"required":["weight","text"],"additionalProperties":false}},"citations":{"type":"object","properties":{"descriptor":{"type":"array","items":{"type":"string"}}},"required":["descriptor"],"additionalProperties":false}},"required":["descriptor","tailwinds","headwinds","citations"],"additionalProperties":false},"sources":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"number":{"type":"string"},"metric":{"type":"string"},"title":{"type":"string"},"meta":{"type":"string"}},"required":["number","metric","title","meta"],"additionalProperties":false}},"footer":{"type":"string"}},"required":["items","footer"],"additionalProperties":false},"forecast":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"shortName":{"type":"string"},"description":{"type":"string"},"audienceName":{"type":"string"},"audienceIsNew":{"type":"boolean"},"demandGrowth":{"type":"string"},"direction":{"type":"string","enum":["tailwind","headwind","mixed"]},"impactWhen":{"type":"string"},"category":{"type":"string"},"persistence":{"type":"string"},"existingLineRel":{"type":"string"},"readiness":{"type":"string"},"businessImpact":{"type":"string"},"readinessRationale":{"type":"string"},"evidence":{"type":"string"},"customerPhrasings":{"type":"array","items":{"type":"string"}}},"required":["id","shortName","description","audienceName","audienceIsNew","demandGrowth","direction","impactWhen","category","persistence","existingLineRel","readiness","businessImpact","readinessRationale","evidence","customerPhrasings"],"additionalProperties":false}},"forecastSummary":{"type":"object","properties":{"descriptor":{"type":"string"}},"required":["descriptor"],"additionalProperties":false}},"required":["hero","facts","revenue"],"additionalProperties":false},{"type":"null"}]}},"required":["id","name","hostname","recordStatus","forecastRecordStatus","profileArtifactAvailable","profileLatestAttemptState","profileGenerationProgress","forecastArtifactAvailable","forecastLatestAttemptState","forecastGenerationProgress","updatedAt","providerCount","profileQuality","generatedByRunId","forecastGeneratedByRunId","detail"],"additionalProperties":false},"BusinessRevenue":{"type":"object","properties":{"descriptor":{"type":"string"},"mix":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"percent":{"type":"number"},"revenue":{"anyOf":[{"type":"string"},{"type":"null"}]},"subs":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label","percent","subs"],"additionalProperties":false}},"headline":{"type":"object","properties":{"value":{"type":"string"},"period":{"type":"string"},"growth":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["value","period","growth"],"additionalProperties":false},"annualRevenue":{"anyOf":[{"type":"string"},{"type":"null"}]},"growthEngine":{"type":"array","items":{"type":"object","properties":{"editPath":{"type":"string"},"leadEditPath":{"type":"string"},"lead":{"type":"string"},"body":{"type":"string"}},"required":["lead","body"],"additionalProperties":false}},"citations":{"type":"object","properties":{"title":{"type":"array","items":{"type":"string"}},"mix":{"type":"array","items":{"type":"string"}},"growthEngine":{"type":"array","items":{"type":"string"}}},"required":["title","mix","growthEngine"],"additionalProperties":false}},"required":["descriptor","mix","headline","growthEngine","citations"],"additionalProperties":false},"BusinessOwnership":{"type":"object","properties":{"type":{"type":"string"},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"parentCompany":{"anyOf":[{"type":"string"},{"type":"null"}]},"publicTicker":{"anyOf":[{"type":"string"},{"type":"null"}]},"holderFinding":{"type":"object","properties":{"status":{"type":"string","enum":["material_holders_identified","widely_held_no_controlling_holder","none_identified_after_research","unavailable"]},"statement":{"type":"string"},"citations":{"type":"array","items":{"type":"string"}}},"required":["status","statement","citations"],"additionalProperties":false},"owners":{"type":"array","items":{"type":"object","properties":{"editPath":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"estimatedOwnership":{"anyOf":[{"type":"string"},{"type":"null"}]},"estimatedOwnershipBasis":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["name","type","description","estimatedOwnership","estimatedOwnershipBasis"],"additionalProperties":false}},"history":{"type":"array","items":{"type":"object","properties":{"editPath":{"type":"string"},"year":{"type":"string"},"label":{"type":"string"},"transition":{"type":"string"}},"required":["year","label","transition"],"additionalProperties":false}},"citations":{"type":"object","properties":{"structure":{"type":"array","items":{"type":"string"}},"owners":{"type":"array","items":{"type":"string"}},"holder":{"type":"array","items":{"type":"string"}},"history":{"type":"array","items":{"type":"string"}}},"required":["structure","owners","holder","history"],"additionalProperties":false}},"required":["type","note","parentCompany","publicTicker","holderFinding","owners","history","citations"],"additionalProperties":false},"BusinessAudiences":{"type":"object","properties":{"descriptor":{"type":"string"},"rows":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"audienceType":{"anyOf":[{"type":"string"},{"type":"null"}]},"revenue":{"anyOf":[{"type":"string"},{"type":"null"}]},"share":{"type":"string"}},"required":["name","revenue","share"],"additionalProperties":false}},"total":{"type":"object","properties":{"revenue":{"anyOf":[{"type":"string"},{"type":"null"}]},"share":{"type":"string"}},"required":["revenue","share"],"additionalProperties":false},"kpis":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"},"unit":{"anyOf":[{"type":"string"},{"type":"null"}]},"delta":{"anyOf":[{"type":"object","properties":{"text":{"type":"string"},"direction":{"type":"string","enum":["up","down","neutral"]}},"required":["text","direction"],"additionalProperties":false},{"type":"null"}]},"citations":{"type":"array","items":{"type":"string"}}},"required":["label","value","unit","delta","citations"],"additionalProperties":false}},"valueProposition":{"type":"array","items":{"type":"object","properties":{"editPath":{"type":"string"},"leadEditPath":{"type":"string"},"lead":{"type":"string"},"body":{"type":"string"}},"required":["lead","body"],"additionalProperties":false}},"drivers":{"type":"array","items":{"type":"object","properties":{"editPath":{"type":"string"},"leadEditPath":{"type":"string"},"lead":{"type":"string"},"body":{"type":"string"}},"required":["lead","body"],"additionalProperties":false}},"citations":{"type":"object","properties":{"audiences":{"type":"array","items":{"type":"string"}},"valueProposition":{"type":"array","items":{"type":"string"}}},"required":["audiences","valueProposition"],"additionalProperties":false}},"required":["descriptor","rows","total","kpis","valueProposition","drivers","citations"],"additionalProperties":false},"BusinessGeography":{"type":"object","properties":{"descriptor":{"type":"string"},"projection":{"type":"object","properties":{"status":{"type":"string","enum":["complete","partial","unmappable"]},"rows":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"weightPct":{"type":"number"},"classification":{"anyOf":[{"type":"string"},{"type":"null"}]},"marketSize":{"type":"string"},"revenueWeightBasis":{"anyOf":[{"type":"string"},{"type":"null"}]},"evidence":{"anyOf":[{"type":"string"},{"type":"null"}]},"projection":{"type":"object","properties":{"state":{"type":"string","enum":["mapped","partial","unmappable"]},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"precision":{"type":"string","enum":["country","admin1","admin2","locality","postal","mixed","unavailable"]},"countryCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"subdivisionCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"areaLabels":{"type":"array","items":{"type":"string"}},"provenance":{"anyOf":[{"type":"object","properties":{"compilerVersion":{"type":"string"},"scopeFingerprint":{"type":"string"},"snapshotVersion":{"type":"string"},"scopeAreaRecordIds":{"type":"array","items":{"type":"string"}}},"required":["compilerVersion","scopeFingerprint","snapshotVersion","scopeAreaRecordIds"],"additionalProperties":false},{"type":"null"}]}},"required":["state","reason","precision","countryCode","subdivisionCode","areaLabels","provenance"],"additionalProperties":false}},"required":["id","name","weightPct","classification","marketSize","revenueWeightBasis","evidence","projection"],"additionalProperties":false}},"scopes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"level":{"type":"string","enum":["country","admin1","postal"]},"countryCode":{"type":"string"},"admin1Code":{"type":"string"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"code":{"type":"string"},"label":{"type":"string"},"value":{"type":"number"},"detail":{"type":"string"},"marketId":{"type":"string"},"groupId":{"type":"string"},"drilldownScopeId":{"type":"string"}},"required":["id","code","label","value","detail"],"additionalProperties":false}},"groups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"weightPct":{"type":"number"},"areaCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"totalAreaCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"precision":{"type":"string","enum":["country","admin1","admin2","locality","postal","mixed","unavailable"]}},"required":["id","label","weightPct","areaCount","totalAreaCount","precision"],"additionalProperties":false}}},"required":["id","label","level","data","groups"],"additionalProperties":false}},"defaultScopeId":{"anyOf":[{"type":"string"},{"type":"null"}]},"mappedRowCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"mappedWeightPct":{"type":"number"},"unmappedRowCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"unmappedWeightPct":{"type":"number"}},"required":["status","rows","scopes","defaultScopeId","mappedRowCount","mappedWeightPct","unmappedRowCount","unmappedWeightPct"],"additionalProperties":false},"revenue":{"type":"object","properties":{"byLocationId":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"total":{"type":"object","properties":{"revenue":{"anyOf":[{"type":"string"},{"type":"null"}]},"share":{"type":"string"}},"required":["revenue","share"],"additionalProperties":false}},"required":["byLocationId","total"],"additionalProperties":false},"siteCampaign":{"anyOf":[{"type":"object","properties":{"name":{"type":"string"},"href":{"type":"string"}},"required":["name","href"],"additionalProperties":false},{"type":"null"}]},"storeProfiles":{"type":"array","items":{"type":"object","properties":{"locationKey":{"type":"string"},"label":{"type":"string"},"locality":{"anyOf":[{"type":"string"},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}]},"customerCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"href":{"type":"string"}},"required":["locationKey","label","locality","latitude","longitude","customerCount","href"],"additionalProperties":false}},"kpis":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"},"unit":{"anyOf":[{"type":"string"},{"type":"null"}]},"delta":{"anyOf":[{"type":"object","properties":{"text":{"type":"string"},"direction":{"type":"string","enum":["up","down","neutral"]}},"required":["text","direction"],"additionalProperties":false},{"type":"null"}]},"citations":{"type":"array","items":{"type":"string"}}},"required":["label","value","unit","delta","citations"],"additionalProperties":false}},"citations":{"type":"object","properties":{"descriptor":{"type":"array","items":{"type":"string"}}},"required":["descriptor"],"additionalProperties":false}},"required":["descriptor","projection","revenue","siteCampaign","storeProfiles","kpis","citations"],"additionalProperties":false},"BusinessChannelMix":{"type":"object","properties":{"descriptor":{"type":"string"},"rows":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"revenue":{"anyOf":[{"type":"string"},{"type":"null"}]},"share":{"type":"string"},"depth":{"anyOf":[{"type":"number","const":0},{"type":"number","const":1}]}},"required":["name","revenue","share","depth"],"additionalProperties":false}},"total":{"type":"object","properties":{"revenue":{"anyOf":[{"type":"string"},{"type":"null"}]},"share":{"type":"string"}},"required":["revenue","share"],"additionalProperties":false},"volume":{"type":"object","properties":{"value":{"type":"string"},"period":{"type":"string"}},"required":["value","period"],"additionalProperties":false},"kpis":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"},"unit":{"anyOf":[{"type":"string"},{"type":"null"}]},"delta":{"anyOf":[{"type":"object","properties":{"text":{"type":"string"},"direction":{"type":"string","enum":["up","down","neutral"]}},"required":["text","direction"],"additionalProperties":false},{"type":"null"}]},"citations":{"type":"array","items":{"type":"string"}}},"required":["label","value","unit","delta","citations"],"additionalProperties":false}},"drivers":{"type":"array","items":{"type":"object","properties":{"editPath":{"type":"string"},"leadEditPath":{"type":"string"},"lead":{"type":"string"},"body":{"type":"string"}},"required":["lead","body"],"additionalProperties":false}},"citations":{"type":"object","properties":{"descriptor":{"type":"array","items":{"type":"string"}}},"required":["descriptor"],"additionalProperties":false}},"required":["descriptor","rows","total","volume","kpis","drivers","citations"],"additionalProperties":false},"BusinessEnvironment":{"type":"object","properties":{"descriptor":{"type":"string"},"regulatory":{"type":"array","items":{"type":"object","properties":{"editPath":{"type":"string"},"leadEditPath":{"type":"string"},"lead":{"type":"string"},"body":{"type":"string"}},"required":["lead","body"],"additionalProperties":false}},"moats":{"type":"array","items":{"type":"object","properties":{"score":{"type":"string"},"weak":{"type":"boolean"},"name":{"type":"string"},"note":{"type":"string"}},"required":["score","weak","name","note"],"additionalProperties":false}},"kpis":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"},"unit":{"anyOf":[{"type":"string"},{"type":"null"}]},"delta":{"anyOf":[{"type":"object","properties":{"text":{"type":"string"},"direction":{"type":"string","enum":["up","down","neutral"]}},"required":["text","direction"],"additionalProperties":false},{"type":"null"}]},"citations":{"type":"array","items":{"type":"string"}}},"required":["label","value","unit","delta","citations"],"additionalProperties":false}},"drivers":{"type":"array","items":{"type":"object","properties":{"editPath":{"type":"string"},"leadEditPath":{"type":"string"},"lead":{"type":"string"},"body":{"type":"string"}},"required":["lead","body"],"additionalProperties":false}},"citations":{"type":"object","properties":{"regulatory":{"type":"array","items":{"type":"string"}},"defensibility":{"type":"array","items":{"type":"string"}}},"required":["regulatory","defensibility"],"additionalProperties":false}},"required":["descriptor","regulatory","moats","kpis","drivers","citations"],"additionalProperties":false},"BusinessCapabilities":{"anyOf":[{"$ref":"#/components/schemas/BusinessCapabilitiesVariant"},{"type":"null"}]},"BusinessCapabilitiesVariant":{"type":"object","properties":{"canArchive":{"type":"boolean"},"archiveDisabledReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"canRestore":{"type":"boolean"},"restoreDisabledReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"canDelete":{"type":"boolean"},"deleteDisabledReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"canRefresh":{"type":"boolean"},"refreshDisabledReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"canEdit":{"type":"boolean"},"editDisabledReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"canGenerateCustomers":{"type":"boolean"},"generateCustomersDisabledReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"canGenerateForecast":{"type":"boolean"},"generateForecastDisabledReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"canLaunchCampaign":{"type":"boolean"},"launchCampaignDisabledReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"canUseCurrentForecastForCampaignSetup":{"type":"boolean"},"useCurrentForecastForCampaignSetupDisabledReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"canGenerateCustomersFromCurrentForecast":{"type":"boolean"},"generateCustomersFromCurrentForecastDisabledReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"shouldShowForecastsInDefaultList":{"type":"boolean"},"forecastVisibilityReason":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["canArchive","archiveDisabledReason","canRestore","restoreDisabledReason","canDelete","deleteDisabledReason","canRefresh","refreshDisabledReason","canEdit","editDisabledReason","canGenerateCustomers","generateCustomersDisabledReason","canGenerateForecast","generateForecastDisabledReason","canLaunchCampaign","launchCampaignDisabledReason","canUseCurrentForecastForCampaignSetup","useCurrentForecastForCampaignSetupDisabledReason","canGenerateCustomersFromCurrentForecast","generateCustomersFromCurrentForecastDisabledReason","shouldShowForecastsInDefaultList","forecastVisibilityReason"],"additionalProperties":false},"BusinessProfile4":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"hostname":{"type":"string"},"recordStatus":{"type":"string","enum":["active","archived","deleted"]},"forecastRecordStatus":{"anyOf":[{"type":"string","enum":["active","archived","deleted"]},{"type":"null"}]},"profileArtifactAvailable":{"type":"boolean"},"profileLatestAttemptState":{"anyOf":[{"type":"string","enum":["running","succeeded","failed","cancelled","partial"]},{"type":"null"}]},"profileGenerationProgress":{"anyOf":[{"type":"object","properties":{"state":{"type":"string"},"label":{"type":"string"},"takingLonger":{"type":"boolean"},"executionStatus":{"type":"string","enum":["waiting","running"]}},"required":["state","label","takingLonger","executionStatus"],"additionalProperties":false},{"type":"null"}]},"forecastArtifactAvailable":{"type":"boolean"},"forecastLatestAttemptState":{"anyOf":[{"type":"string","enum":["running","succeeded","failed","cancelled","partial"]},{"type":"null"}]},"forecastGenerationProgress":{"anyOf":[{"type":"object","properties":{"state":{"type":"string"},"label":{"type":"string"},"takingLonger":{"type":"boolean"},"executionStatus":{"type":"string","enum":["waiting","running"]}},"required":["state","label","takingLonger","executionStatus"],"additionalProperties":false},{"type":"null"}]},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"providerCount":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"profileQuality":{"type":"string","enum":["complete","limited_evidence"]},"generatedByRunId":{"anyOf":[{"type":"string"},{"type":"null"}]},"forecastGeneratedByRunId":{"anyOf":[{"type":"string"},{"type":"null"}]},"detail":{"anyOf":[{"type":"object","properties":{"hero":{"type":"object","properties":{"about":{"type":"string"},"mission":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}}},"required":["about","mission","tags"],"additionalProperties":false},"facts":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"},"citations":{"type":"array","items":{"type":"string"}}},"required":["label","value","citations"],"additionalProperties":false}},"revenue":{"$ref":"#/components/schemas/BusinessRevenue"},"overview":{"type":"array","items":{"type":"object","properties":{"editPath":{"type":"string"},"leadEditPath":{"type":"string"},"lead":{"type":"string"},"body":{"type":"string"}},"required":["lead","body"],"additionalProperties":false}},"operations":{"type":"object","properties":{"operatingModel":{"type":"array","items":{"type":"object","properties":{"editPath":{"type":"string"},"leadEditPath":{"type":"string"},"lead":{"type":"string"},"body":{"type":"string"}},"required":["lead","body"],"additionalProperties":false}},"costStructure":{"type":"array","items":{"type":"object","properties":{"editPath":{"type":"string"},"leadEditPath":{"type":"string"},"lead":{"type":"string"},"body":{"type":"string"}},"required":["lead","body"],"additionalProperties":false}},"citations":{"type":"object","properties":{"operatingModel":{"type":"array","items":{"type":"string"}},"costStructure":{"type":"array","items":{"type":"string"}}},"required":["operatingModel","costStructure"],"additionalProperties":false}},"required":["operatingModel","costStructure","citations"],"additionalProperties":false},"assets":{"type":"object","properties":{"assetBase":{"type":"array","items":{"type":"object","properties":{"editPath":{"type":"string"},"leadEditPath":{"type":"string"},"lead":{"type":"string"},"body":{"type":"string"}},"required":["lead","body"],"additionalProperties":false}},"citations":{"type":"object","properties":{"assetBase":{"type":"array","items":{"type":"string"}}},"required":["assetBase"],"additionalProperties":false}},"required":["assetBase","citations"],"additionalProperties":false},"leaders":{"type":"array","items":{"type":"object","properties":{"bioEditPath":{"type":"string"},"title":{"type":"string"},"tenureStart":{"anyOf":[{"type":"number"},{"type":"null"}]},"editPath":{"type":"string"},"initials":{"type":"string"},"name":{"type":"string"},"role":{"type":"string"},"bio":{"type":"string"}},"required":["initials","name","role","bio"],"additionalProperties":false}},"ownership":{"$ref":"#/components/schemas/BusinessOwnership"},"financials":{"type":"object","properties":{"actuals":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"},"unit":{"anyOf":[{"type":"string"},{"type":"null"}]},"citations":{"type":"array","items":{"type":"string"}},"meta":{"type":"array","items":{"type":"string"}}},"required":["label","value","unit","citations"],"additionalProperties":false}},"citations":{"type":"object","properties":{"actuals":{"type":"array","items":{"type":"string"}}},"required":["actuals"],"additionalProperties":false}},"required":["actuals","citations"],"additionalProperties":false},"audiences":{"$ref":"#/components/schemas/BusinessAudiences"},"history":{"type":"array","items":{"type":"object","properties":{"editPaths":{"type":"object","properties":{"marker":{"type":"string"},"body":{"type":"string"}},"required":["marker","body"],"additionalProperties":false},"marker":{"type":"string"},"body":{"type":"string"},"major":{"type":"boolean"},"citations":{"type":"array","items":{"type":"string"}}},"required":["marker","body","major","citations"],"additionalProperties":false}},"geography":{"$ref":"#/components/schemas/BusinessGeography"},"channelMix":{"$ref":"#/components/schemas/BusinessChannelMix"},"competitors":{"type":"object","properties":{"descriptor":{"type":"string"},"rows":{"type":"array","items":{"type":"object","properties":{"editPaths":{"type":"object","properties":{"name":{"type":"string"},"note":{"type":"string"},"overlap":{"type":"array","items":{"type":"string"}},"intensity":{"type":"string"},"trend":{"type":"string"}},"required":["name","overlap"],"additionalProperties":false},"name":{"type":"string"},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"intensityPct":{"anyOf":[{"type":"number"},{"type":"null"}]},"intensity":{"anyOf":[{"type":"string"},{"type":"null"}]},"overlap":{"anyOf":[{"type":"string"},{"type":"null"}]},"trendDirection":{"anyOf":[{"type":"string","enum":["rising","stable","declining"]},{"type":"null"}]},"trendDeltaPct":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["name","note","intensityPct","intensity","overlap","trendDirection","trendDeltaPct"],"additionalProperties":false}},"kpis":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"},"unit":{"anyOf":[{"type":"string"},{"type":"null"}]},"delta":{"anyOf":[{"type":"object","properties":{"text":{"type":"string"},"direction":{"type":"string","enum":["up","down","neutral"]}},"required":["text","direction"],"additionalProperties":false},{"type":"null"}]},"citations":{"type":"array","items":{"type":"string"}}},"required":["label","value","unit","delta","citations"],"additionalProperties":false}},"battlegrounds":{"type":"array","items":{"type":"object","properties":{"editPath":{"type":"string"},"leadEditPath":{"type":"string"},"lead":{"type":"string"},"body":{"type":"string"},"competitors":{"type":"array","items":{"type":"string"}}},"required":["lead","body","competitors"],"additionalProperties":false}},"citations":{"type":"object","properties":{"descriptor":{"type":"array","items":{"type":"string"}}},"required":["descriptor"],"additionalProperties":false}},"required":["descriptor","rows","kpis","battlegrounds","citations"],"additionalProperties":false},"environment":{"$ref":"#/components/schemas/BusinessEnvironment"},"recentEvents":{"type":"array","items":{"type":"object","properties":{"editPaths":{"type":"object","properties":{"marker":{"type":"string"},"body":{"type":"string"}},"required":["marker","body"],"additionalProperties":false},"marker":{"type":"string"},"body":{"type":"string"},"major":{"type":"boolean"},"citations":{"type":"array","items":{"type":"string"}}},"required":["marker","body","major","citations"],"additionalProperties":false}},"outlook":{"type":"object","properties":{"descriptor":{"type":"string"},"tailwinds":{"type":"array","items":{"type":"object","properties":{"weight":{"type":"string"},"text":{"type":"string"}},"required":["weight","text"],"additionalProperties":false}},"headwinds":{"type":"array","items":{"type":"object","properties":{"weight":{"type":"string"},"text":{"type":"string"}},"required":["weight","text"],"additionalProperties":false}},"citations":{"type":"object","properties":{"descriptor":{"type":"array","items":{"type":"string"}}},"required":["descriptor"],"additionalProperties":false}},"required":["descriptor","tailwinds","headwinds","citations"],"additionalProperties":false},"sources":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"number":{"type":"string"},"metric":{"type":"string"},"title":{"type":"string"},"meta":{"type":"string"}},"required":["number","metric","title","meta"],"additionalProperties":false}},"footer":{"type":"string"}},"required":["items","footer"],"additionalProperties":false},"forecast":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"shortName":{"type":"string"},"description":{"type":"string"},"audienceName":{"type":"string"},"audienceIsNew":{"type":"boolean"},"demandGrowth":{"type":"string"},"direction":{"type":"string","enum":["tailwind","headwind","mixed"]},"impactWhen":{"type":"string"},"category":{"type":"string"},"persistence":{"type":"string"},"existingLineRel":{"type":"string"},"readiness":{"type":"string"},"businessImpact":{"type":"string"},"readinessRationale":{"type":"string"},"evidence":{"type":"string"},"customerPhrasings":{"type":"array","items":{"type":"string"}}},"required":["id","shortName","description","audienceName","audienceIsNew","demandGrowth","direction","impactWhen","category","persistence","existingLineRel","readiness","businessImpact","readinessRationale","evidence","customerPhrasings"],"additionalProperties":false}},"forecastSummary":{"type":"object","properties":{"descriptor":{"type":"string"}},"required":["descriptor"],"additionalProperties":false}},"required":["hero","facts","revenue"],"additionalProperties":false},{"type":"null"}]}},"required":["id","name","hostname","recordStatus","forecastRecordStatus","profileArtifactAvailable","profileLatestAttemptState","profileGenerationProgress","forecastArtifactAvailable","forecastLatestAttemptState","forecastGenerationProgress","updatedAt","providerCount","profileQuality","generatedByRunId","forecastGeneratedByRunId","detail"],"additionalProperties":false},"BusinessData":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customerKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"type":"string"},"businessProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"businessProfileKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"profileName":{"anyOf":[{"type":"string"},{"type":"null"}]},"profileUrl":{"type":"string"},"profileBusinessSummary":{"anyOf":[{"type":"string"},{"type":"null"}]},"source":{"type":"string","enum":["generated","manual","connected"]},"poolStatus":{"type":"string","enum":["active","retired"]},"retiredAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"forecastSeeded":{"type":"boolean"},"audiences":{"type":"array","items":{"type":"string"}},"systemAudiences":{"type":"array","items":{"type":"string"}},"userAudiences":{"type":"array","items":{"type":"string"}},"userAudienceIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"sources":{"type":"array","items":{"type":"string"}},"jobTitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"gender":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Gender"},"age":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Age"},"age.band":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Age band"},"language":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Language"},"location":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Location"},"market":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Market"},"areaType":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Area type"},"education":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Education"},"lifeStage":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Life stage"},"householdIncome":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Household income"},"householdIncome.band":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Income band"},"occupation":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Occupation"},"seniority":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Seniority"},"employer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Employer"},"companySize":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Company size"},"companySize.band":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Size band"},"annualRevenue":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Annual revenue"},"buyerType":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Buyer type"},"audience":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Audience"},"product":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Product"},"channel":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Channel"},"buyerRole":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Buyer role"},"intentStage":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Intent stage"},"job":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Job to be done"},"triggerType":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","label"],"additionalProperties":false},{"type":"null"}],"description":"Trigger type"},"trigger":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Trigger"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"generationRunId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"latestDiscoveryOutcome":{"$ref":"#/components/schemas/DiscoveryItemLatestDiscoveryOutcome"},"audienceMemberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"createdBy":{"type":"string","enum":["system","user"]}},"required":["id","name","createdBy"],"additionalProperties":false}},"place":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"\"City, ST\"."},"ineligibleReason":{"anyOf":[{"type":"string","enum":["deleted","archived","other_profile","forecast_customer","not_store_customer","other_store","not_forecast_customer","connected_not_ready","outside_audience","unavailable"]},{"type":"null"}],"description":"Why the pick cannot take the customer; null when it can."}},"required":["id","customerKey","label","businessProfileId","businessProfileKey","profileName","profileUrl","profileBusinessSummary","source","poolStatus","retiredAt","forecastSeeded","audiences","systemAudiences","userAudiences","userAudienceIds","sources","jobTitle","gender","age","age.band","language","location","market","areaType","education","lifeStage","householdIncome","householdIncome.band","occupation","seniority","employer","companySize","companySize.band","annualRevenue","buyerType","audience","product","channel","buyerRole","intentStage","job","triggerType","trigger","createdAt","generationRunId","latestDiscoveryOutcome","audienceMemberships","place","ineligibleReason"],"additionalProperties":false}},"BusinessSchedule":{"anyOf":[{"$ref":"#/components/schemas/BusinessScheduleVariant"},{"type":"null"}],"description":"The weekly schedule in effect; null when the line has none."},"BusinessScheduleVariant":{"type":"object","properties":{"valid_from":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"valid_through":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"date_overrides":{"maxItems":32,"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"weight_multiplier":{"type":"number","minimum":0,"maximum":10},"label":{"type":"string","minLength":1,"maxLength":120},"basis":{"anyOf":[{"type":"string","minLength":1,"maxLength":1000},{"type":"null"}]},"evidence_refs":{"minItems":1,"maxItems":32,"type":"array","items":{"type":"string","minLength":1,"maxLength":500}}},"required":["date","weight_multiplier","label","basis","evidence_refs"],"additionalProperties":false}},"time_zone":{"anyOf":[{"type":"string","minLength":1,"maxLength":64},{"type":"null"}]},"weekly_windows":{"minItems":1,"maxItems":32,"type":"array","items":{"type":"object","properties":{"days":{"minItems":1,"maxItems":7,"type":"array","items":{"type":"string","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]}},"start_hour_local":{"type":"integer","minimum":0,"maximum":23},"end_hour_local":{"type":"integer","minimum":1,"maximum":24},"relative_weight":{"type":"number","exclusiveMinimum":0,"maximum":100},"label":{"anyOf":[{"type":"string","minLength":1,"maxLength":120},{"type":"null"}]}},"required":["days","start_hour_local","end_hour_local","relative_weight","label"],"additionalProperties":false}},"annual_modifiers":{"maxItems":32,"type":"array","items":{"type":"object","properties":{"start_month_day":{"type":"string","pattern":"^(0[1-9]|1[0-2])-([0-2]\\d|3[01])$"},"end_month_day":{"type":"string","pattern":"^(0[1-9]|1[0-2])-([0-2]\\d|3[01])$"},"weight_multiplier":{"type":"number","minimum":0,"maximum":10},"label":{"type":"string","minLength":1,"maxLength":120},"basis":{"anyOf":[{"type":"string","minLength":1,"maxLength":1000},{"type":"null"}]}},"required":["start_month_day","end_month_day","weight_multiplier","label","basis"],"additionalProperties":false}},"exceptions":{"maxItems":32,"type":"array","items":{"type":"object","properties":{"start_date":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"end_date":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"weekly_windows":{"maxItems":32,"type":"array","items":{"type":"object","properties":{"days":{"minItems":1,"maxItems":7,"type":"array","items":{"type":"string","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]}},"start_hour_local":{"type":"integer","minimum":0,"maximum":23},"end_hour_local":{"type":"integer","minimum":1,"maximum":24},"relative_weight":{"type":"number","exclusiveMinimum":0,"maximum":100},"label":{"anyOf":[{"type":"string","minLength":1,"maxLength":120},{"type":"null"}]}},"required":["days","start_hour_local","end_hour_local","relative_weight","label"],"additionalProperties":false}},"label":{"type":"string","minLength":1,"maxLength":120},"basis":{"anyOf":[{"type":"string","minLength":1,"maxLength":1000},{"type":"null"}]},"evidence_refs":{"maxItems":32,"type":"array","items":{"type":"string","minLength":1,"maxLength":500}}},"required":["start_date","end_date","weekly_windows","label","basis","evidence_refs"],"additionalProperties":false}},"confidence":{"type":"string","enum":["low","medium","high"]},"basis":{"type":"string","minLength":1,"maxLength":2000},"evidence_refs":{"minItems":1,"maxItems":32,"type":"array","items":{"type":"string","minLength":1,"maxLength":500}}},"required":["time_zone","weekly_windows","annual_modifiers","confidence","basis","evidence_refs"],"additionalProperties":false},"BusinessSubject":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"csv"},"columns":{"minItems":1,"maxItems":120,"type":"array","items":{"type":"object","properties":{"header":{"type":"string","minLength":1,"maxLength":200},"samples":{"maxItems":5,"type":"array","items":{"type":"string","maxLength":200}},"locked":{"type":"string","enum":["identifier","regulated","protected"]}},"required":["header","samples"],"additionalProperties":false}}},"required":["kind","columns"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"connector"},"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"objectType":{"type":"string","enum":["contacts","companies","leads"]},"collection":{"type":"object","properties":{"kind":{"type":"string","enum":["all","list","list_view"]},"id":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["kind","id","label"],"additionalProperties":false},"mode":{"type":"string","enum":["audience","contacts"]}},"required":["kind","connectionId","objectType","collection","mode"],"additionalProperties":false}]},"BusinessCurrentVersion":{"anyOf":[{"$ref":"#/components/schemas/BusinessCurrentVersionVariant"},{"type":"null"}]},"BusinessCurrentVersionVariant":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lineageId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"createdBy":{"anyOf":[{"type":"object","properties":{"userId":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["userId","name"],"additionalProperties":false},{"type":"null"}]},"createdVia":{"type":"string","enum":["member","operator","bootstrap"]},"fieldCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"mappedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"humanDecisionCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"decisionDigest":{"type":"string"},"declaredInputDigest":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","lineageId","version","createdAt","createdBy","createdVia","fieldCount","mappedCount","humanDecisionCount","decisionDigest","declaredInputDigest"],"additionalProperties":false},"BusinessDrift":{"anyOf":[{"type":"object","properties":{"comparedVersionId":{"type":"string"},"observedFieldCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"mappedFieldAffected":{"type":"boolean"},"added":{"type":"object","properties":{"count":{"type":"integer","minimum":0,"maximum":9007199254740991},"fields":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"},"valueType":{"type":"string","enum":["text","long_text","number","currency","percent","boolean","date","datetime","picklist","multi_picklist","reference","other"]},"custom":{"type":"boolean"},"availability":{"type":"string","enum":["proposable","manual_only","locked"]}},"required":["key","label","valueType","custom","availability"],"additionalProperties":false}}},"required":["count","fields"],"additionalProperties":false},"removed":{"type":"object","properties":{"count":{"type":"integer","minimum":0,"maximum":9007199254740991},"fields":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"},"mapped":{"type":"boolean"}},"required":["key","label","mapped"],"additionalProperties":false}}},"required":["count","fields"],"additionalProperties":false},"renamed":{"type":"object","properties":{"count":{"type":"integer","minimum":0,"maximum":9007199254740991},"fields":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"mapped":{"type":"boolean"}},"required":["key","from","to","mapped"],"additionalProperties":false}}},"required":["count","fields"],"additionalProperties":false},"typeChanged":{"type":"object","properties":{"count":{"type":"integer","minimum":0,"maximum":9007199254740991},"fields":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"mapped":{"type":"boolean"}},"required":["key","from","to","mapped"],"additionalProperties":false}}},"required":["count","fields"],"additionalProperties":false},"newlyLocked":{"type":"object","properties":{"count":{"type":"integer","minimum":0,"maximum":9007199254740991},"fields":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"},"reason":{"type":"string","enum":["identity","identifier","regulated","protected","unsupported_type"]},"mapped":{"type":"boolean"}},"required":["key","label","reason","mapped"],"additionalProperties":false}}},"required":["count","fields"],"additionalProperties":false}},"required":["comparedVersionId","observedFieldCount","mappedFieldAffected","added","removed","renamed","typeChanged","newlyLocked"],"additionalProperties":false},{"type":"null"}]},"BusinessDecision":{"type":"object","properties":{"disposition":{"type":"string","enum":["mapped","not_imported","rejected"]},"target":{"anyOf":[{"type":"string","enum":["age","language","location","market","areaType","education","lifeStage","household","householdIncome","jobTitle","occupation","seniority","employer","yearsInRole","companySize","annualRevenue","audience","product","channel","buyerRole","stakeholders","intentStage","budget","constraints","job","situation","triggerType","trigger","functionalNeed","emotionalNeed","socialNeed","desiredOutcome","labels","website","industry","lifecycle_stage","spend","purchase_frequency","tier","notes","context","public_figure_context","department","lead_status","country_code"]},{"type":"null"}]},"rejectedCategory":{"anyOf":[{"type":"string","enum":["identifier","regulated","protected","unmappable"]},{"type":"null"}]},"decider":{"type":"string","enum":["rail","model","human","product_default"]},"railRule":{"anyOf":[{"type":"string"},{"type":"null"}]},"modelRunId":{"anyOf":[{"type":"string"},{"type":"null"}]},"decidedByUserId":{"anyOf":[{"type":"string"},{"type":"null"}]},"inheritedFromVersionId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["disposition","target","rejectedCategory","decider","railRule","modelRunId","decidedByUserId","inheritedFromVersionId"],"additionalProperties":false},"ReportsDimensions":{"type":"object","properties":{"key":{"type":"string","description":"A key a report definition names."},"label":{"type":"string"},"kind":{"type":"string","enum":["customer","evidence","time"],"description":"`customer`: an attribute of the customer the interaction ran against. `evidence`: what the interaction found or ran on. `time`: the day a window's figure is read as of."},"multiValued":{"type":"boolean","description":"One interaction can hold several of its values, so its cells never add up to their total."},"filterable":{"type":"boolean","description":"Whether a report may keep only some of its values."},"sortable":{"description":"A records dataset's field a report may sort by.","type":"boolean","const":true},"filterOnly":{"description":"A dimension a report can only filter by, never group by or show.","type":"boolean","const":true},"singleValueFilter":{"description":"A report's filter on it keeps one value at most.","type":"boolean","const":true}},"required":["key","label","kind","multiValued","filterable"],"additionalProperties":false},"ReportsSpan":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"window"},"asOf":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"The UTC day every value is as of: its trailing 30 days."},"from":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"to":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"comparedTo":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"The as-of day of the window a comparison reads."}},"required":["kind","asOf","from","to","comparedTo"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"range"},"from":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"to":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"}},"required":["kind","from","to"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"campaigns"},"campaigns":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"How many campaigns had results, each read over its own window."},"from":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"The earliest campaign window's first day."},"to":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"The latest campaign window's last day."}},"required":["kind","campaigns","from","to"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"run"},"runId":{"type":"string","description":"The run the figures were read from."},"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"The UTC day the run started."}},"required":["kind","runId","day"],"additionalProperties":false}],"description":"What the figures were read over: a window dataset's trailing 30-day results window, a range dataset's days, every campaign pooled, each over its own window, or one run as it ran (its figures state no precision)."},"ReportsCells":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/ReportsCellsVariant"},"description":"Each cell by its column's id."},"ReportsCellsVariant":{"type":"object","properties":{"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The value as the report shows it: itself, or its share (0-100) of its row, column or total."},"precision":{"$ref":"#/components/schemas/ReportsPrecision"},"earlier":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The value over the window 30 days earlier, when the report compares."}},"required":["value","precision","earlier"],"additionalProperties":false},"ReportsPrecision":{"anyOf":[{"type":"object","properties":{"basis":{"type":"string","enum":["share","derived"]},"span":{"type":"string","enum":["window","range"]},"customers":{"type":"integer","minimum":0,"maximum":9007199254740991},"marginOfErrorPts":{"type":"number"},"level":{"type":"string","enum":["low","standard"]},"change":{"anyOf":[{"type":"object","properties":{"points":{"type":"number"},"comparedTo":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"significant":{"type":"boolean"},"instrumentChanged":{"type":"boolean","const":true}},"required":["points","comparedTo","significant"],"additionalProperties":false},{"type":"null"}]}},"required":["basis","span","customers","marginOfErrorPts","level","change"],"additionalProperties":false,"description":"The value's precision over the distinct customers behind it."},{"type":"null"}]},"ReportsPointsItem":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/ReportsCellsVariant"}},"ReportsDefinition":{"oneOf":[{"type":"object","properties":{"version":{"type":"number","const":1},"grain":{"type":"string","const":"aggregate"},"dataset":{"type":"string","maxLength":96,"pattern":"^(?:discovery|experience|research)\\.[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"},"scope":{"type":"object","properties":{"campaignId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"profileId":{"default":null,"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"dateRange":{"anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},"required":["campaignId","profileId","dateRange"],"additionalProperties":false},"rows":{"maxItems":4,"type":"array","items":{"type":"string","maxLength":64,"pattern":"^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"}},"columns":{"maxItems":2,"type":"array","items":{"type":"string","maxLength":64,"pattern":"^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"}},"values":{"minItems":1,"maxItems":12,"type":"array","items":{"type":"object","properties":{"measure":{"type":"string","maxLength":64,"pattern":"^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"},"showAs":{"type":"string","enum":["value","row","column","total"]}},"required":["measure","showAs"],"additionalProperties":false}},"filters":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"dimension":{"type":"string","maxLength":64,"pattern":"^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"},"values":{"minItems":1,"maxItems":200,"type":"array","items":{"type":"string","minLength":1,"maxLength":256}}},"required":["dimension","values"],"additionalProperties":false}},"sort":{"anyOf":[{"type":"object","properties":{"by":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"dimension"},"key":{"type":"string","maxLength":64,"pattern":"^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"}},"required":["kind","key"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"measure"},"key":{"type":"string","maxLength":64,"pattern":"^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"},"column":{"anyOf":[{"type":"string","maxLength":1024},{"type":"null"}]}},"required":["kind","key","column"],"additionalProperties":false}]},"direction":{"type":"string","enum":["asc","desc"]}},"required":["by","direction"],"additionalProperties":false},{"type":"null"}]},"compare":{"type":"boolean"},"chart":{"anyOf":[{"type":"object","properties":{"mark":{"type":"string","enum":["bar","stacked-bar","stacked-100","line","area","pie"]},"orientation":{"type":"string","enum":["vertical","horizontal"]},"x":{"anyOf":[{"type":"string","maxLength":64,"pattern":"^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"},{"type":"null"}]},"y":{"type":"integer","minimum":0,"maximum":11},"topN":{"type":"integer","minimum":1,"maximum":25},"labels":{"type":"boolean"}},"required":["mark","orientation","x","y","topN","labels"],"additionalProperties":false},{"type":"null"}]}},"required":["version","grain","dataset","scope","rows","columns","values","filters","sort","compare","chart"],"additionalProperties":false},{"type":"object","properties":{"version":{"type":"number","const":1},"grain":{"type":"string","const":"records"},"dataset":{"type":"string","maxLength":96,"pattern":"^(?:discovery|experience|research)\\.[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"},"scope":{"type":"object","properties":{"campaignId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"profileId":{"default":null,"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"dateRange":{"anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},"required":["campaignId","profileId","dateRange"],"additionalProperties":false},"fields":{"minItems":1,"maxItems":30,"type":"array","items":{"type":"string","maxLength":64,"pattern":"^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"}},"filters":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"dimension":{"type":"string","maxLength":64,"pattern":"^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"},"values":{"minItems":1,"maxItems":200,"type":"array","items":{"type":"string","minLength":1,"maxLength":256}}},"required":["dimension","values"],"additionalProperties":false}},"sort":{"anyOf":[{"type":"object","properties":{"field":{"type":"string","maxLength":64,"pattern":"^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"},"direction":{"type":"string","enum":["asc","desc"]}},"required":["field","direction"],"additionalProperties":false},{"type":"null"}]}},"required":["version","grain","dataset","scope","fields","filters","sort"],"additionalProperties":false}]}}},"paths":{"/api/v1/inspector/activities/{id}":{"get":{"operationId":"inspector.activities.get.v1","summary":"Get activities","description":"Read what the Inspector is doing now (id \"organization\"): the scans in the organization's scan list (never the public site's, nor one embedded in another product's run) that are crawling, checking or scoring, as running, and those pending, as waiting (not yet started, no promise of when), each counted with the competitor scans running for it. reading is running or waiting (with how many) or idle; the Inspector schedules nothing. subject names the one scan when exactly one holds the work.","tags":["inspector"],"x-cli-name":"inspector-activities-get","x-point11-scope":"inspector:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","const":"organization"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InspectorActivitiesGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/inspector/scans/start":{"post":{"operationId":"inspector.scans.start.v1","summary":"Start scans","description":"Start a durable AI-readiness scan of one public website URL and of up to five of its competitors' sites beside it, each its own Inspector scan billed as one. Inspector chooses the competitors: those the organization's business profile for the site names (none when it names none). Poll inspector_scans_get_v2 with the returned scanId, or platform_runs_get_v2 with runId, then read inspector_scan_results_get_v2 once it is complete; the scan's report lists its competitors' scores.","tags":["inspector"],"x-cli-name":"inspector-scans-start","x-point11-scope":"inspector:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InspectorScansStartRequest"}}}},"responses":{"202":{"description":"Accepted: the durable run started. Follow it with `GET /api/v1/platform/runs-v2/{id}`.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InspectorScansStartResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/inspector/scans-v2/{id}":{"get":{"operationId":"inspector.scans.get.v2","summary":"Get scans (v2)","description":"Get the status, URL and host, progress, and headline grade of one scan by scan id. Set includeReport to also get the report: the site URL while the scan runs, or once complete its result, per-crawler scores, stored summary, industry percentile, and the competitors scanned beside it (each one's scan id, site, status and score). For findings alone use inspector_scan_results_get_v2.","tags":["inspector"],"x-cli-name":"inspector-scans-get-v2","x-point11-scope":"inspector:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Scan id returned by inspector_scans_start","schema":{"type":"string","minLength":1,"maxLength":64,"description":"Scan id returned by inspector_scans_start"}},{"name":"includeReport","in":"query","required":false,"description":"Also return the report the dashboard renders","schema":{"default":false,"description":"Also return the report the dashboard renders","type":"boolean"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InspectorScansGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/inspector/scans-v2":{"get":{"operationId":"inspector.scans.list.v2","summary":"List scans (v2)","description":"List your organization's own Inspector scans (never a competitor's, which its scan's report lists), newest first unless sortBy names another column, filtered by hostname, lifecycle, a search over hostname and URL, or up to twenty scan ids (to poll the status of scans you started). Pages are keyset-based: nextCursor names the last scan a page listed, and the next page starts right after where that scan sorts now, so scans started, archived, or restored while you page shift nothing across a page. Set includeTotal to also count every match (totalCount, else null) and includePercentile to rank each scored scan in its industry (percentile, else null); both cost extra reads, so they are off by default.","tags":["inspector"],"x-cli-name":"inspector-scans-list-v2","x-point11-scope":"inspector:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"nextCursor from the previous page. A page starts after the last scan the previous page listed, so scans started, archived, or restored while paging do not shift where it starts","schema":{"description":"nextCursor from the previous page. A page starts after the last scan the previous page listed, so scans started, archived, or restored while paging do not shift where it starts","type":"string"}},{"name":"hostname","in":"query","required":false,"description":"Filter by hostname (e.g. example.com); www. and case are ignored","schema":{"description":"Filter by hostname (e.g. example.com); www. and case are ignored","type":"string","maxLength":253}},{"name":"ids","in":"query","required":false,"description":"Only these scan ids (1–20): the table's status poll","schema":{"description":"Only these scan ids (1–20): the table's status poll","minItems":1,"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":64}}},{"name":"lifecycleStatus","in":"query","required":false,"description":"Which scans to list; deleted scans are never listed","schema":{"default":"active","description":"Which scans to list; deleted scans are never listed","type":"string","enum":["active","archived","all"]}},{"name":"query","in":"query","required":false,"description":"Search over hostname and URL","schema":{"default":"","description":"Search over hostname and URL","type":"string","maxLength":200}},{"name":"sortBy","in":"query","required":false,"description":"Sort column","schema":{"default":"createdAt","description":"Sort column","type":"string","enum":["hostname","scoreOverall","status","createdAt","updatedAt","chatgpt","gemini","claude","grok"]}},{"name":"sortDirection","in":"query","required":false,"description":"Sort direction","schema":{"default":"desc","description":"Sort direction","type":"string","enum":["asc","desc"]}},{"name":"includePercentile","in":"query","required":false,"description":"Rank each scored scan in its industry (percentile); off by default, each row's percentile is null","schema":{"default":false,"description":"Rank each scored scan in its industry (percentile); off by default, each row's percentile is null","type":"boolean"}},{"name":"includeTotal","in":"query","required":false,"description":"Count every matching scan (totalCount); off by default, totalCount is null","schema":{"default":false,"description":"Count every matching scan (totalCount); off by default, totalCount is null","type":"boolean"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InspectorScansListV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/inspector/scans/archive":{"post":{"operationId":"inspector.scans.archive.v1","summary":"Archive scans","description":"Archive scans by id so they leave the active list; inspector_scans_restore brings them back. Ids that are missing, deleted, or already archived are counted, not failed.","tags":["inspector"],"x-cli-name":"inspector-scans-archive","x-point11-scope":"inspector:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InspectorScansArchiveRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InspectorScansArchiveResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/inspector/scans/restore":{"post":{"operationId":"inspector.scans.restore.v1","summary":"Restore scans","description":"Restore archived scans by id to the active list. A deleted scan cannot be restored; ids that are missing, deleted, or already active are counted, not failed.","tags":["inspector"],"x-cli-name":"inspector-scans-restore","x-point11-scope":"inspector:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InspectorScansRestoreRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InspectorScansRestoreResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/inspector/scans/delete":{"post":{"operationId":"inspector.scans.delete.v1","summary":"Delete scans","description":"Permanently delete scans by id; a deleted scan never comes back, so confirm with your user first. Ids that are missing or already deleted are counted, not failed.","tags":["inspector"],"x-cli-name":"inspector-scans-delete","x-point11-scope":"inspector:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InspectorScansDeleteRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InspectorScansDeleteResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/inspector/scan-results-v2/{id}":{"get":{"operationId":"inspector.scan-results.get.v2","summary":"Get scan results (v2)","description":"Get the full results of a completed scan by scan id: grade, crawler scores, and every check. Use format full for impact, remediation, and raw data.","tags":["inspector"],"x-cli-name":"inspector-scan-results-get-v2","x-point11-scope":"inspector:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Scan id returned by inspector_scans_start","schema":{"type":"string","minLength":1,"maxLength":64,"description":"Scan id returned by inspector_scans_start"}},{"name":"format","in":"query","required":false,"description":"summary = check findings only, full = includes rawData, impact, remediation","schema":{"default":"summary","description":"summary = check findings only, full = includes rawData, impact, remediation","type":"string","enum":["summary","full"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InspectorScanResultsGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/inspector/scan-checks/{id}":{"get":{"operationId":"inspector.scan-checks.get.v1","summary":"Get scan checks","description":"Get one check's finding, impact, remediation, pages scanned, and raw data within a scan, given the scan id and a checkId from inspector_scan_results_get_v2.","tags":["inspector"],"x-cli-name":"inspector-scan-checks-get","x-point11-scope":"inspector:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Scan id returned by inspector_scans_start","schema":{"type":"string","minLength":1,"maxLength":64,"description":"Scan id returned by inspector_scans_start"}},{"name":"checkId","in":"query","required":true,"description":"The check id (e.g. 'lcp', 'redirect-chains', 'blocking-gptbot')","schema":{"type":"string","minLength":1,"maxLength":128,"description":"The check id (e.g. 'lcp', 'redirect-chains', 'blocking-gptbot')"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InspectorScanChecksGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/inspector/competitor-suggestions/create":{"post":{"operationId":"inspector.competitor-suggestions.create.v1","summary":"Create competitor suggestions","description":"Deprecated: use inspector.competitor-suggestions.create.v2 (inspector_competitor_suggestions_create_v2), which answers an empty competitors list when the model finds no direct competitor; this version answers that as GENERATION_RUN_TERMINAL. Suggest competitors for a public website hostname: the business it belongs to and one to ten competitor domains, as the model found them. Sending the same Idempotency-Key again returns the same run's answer.","deprecated":true,"tags":["inspector"],"x-cli-name":"inspector-competitor-suggestions-create","x-point11-scope":"inspector:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InspectorCompetitorSuggestionsCreateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InspectorCompetitorSuggestionsCreateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/inspector/competitor-suggestions/create-v2":{"post":{"operationId":"inspector.competitor-suggestions.create.v2","summary":"Create competitor suggestions (v2)","description":"Suggest competitors for a public website hostname: the business it belongs to and up to ten competitor domains, as the model found them; an empty list when it found no direct competitor. Sending the same Idempotency-Key again returns the same run's answer, as does a key already sent to version 1.","tags":["inspector"],"x-cli-name":"inspector-competitor-suggestions-create-v2","x-point11-scope":"inspector:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InspectorCompetitorSuggestionsCreateV2Request"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InspectorCompetitorSuggestionsCreateV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/inspector/site-inspections/run":{"get":{"operationId":"inspector.site-inspections.run.v1","summary":"Run site inspections","description":"Inspect one page of one of your organization's own websites, or of a competitor site its business profiles name, live and read-only: what it runs on (commerce platform, CMS, theme, front-end framework, site search, storefront apps, payments, edge), each with the exact evidence it rests on, its readable text, and the surfaces you name (robots, llms, markup, forms, negotiation). Answers outside_site for any other host and blocked_by_challenge when the site served a bot challenge, which says nothing about the page. Starts no scan, publishes no score and stores nothing; each answer is dated to its own read. rendered is not available here (a render needs a run that records the browser's use), so it comes back as a limit.","tags":["inspector"],"x-cli-name":"inspector-site-inspections-run","x-point11-scope":"inspector:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"url","in":"query","required":true,"description":"An absolute http(s) URL on one of the organization's websites: the page whose behaviour the question is about (a product page, a search URL such as /search?q=odor, or the home page).","schema":{"type":"string","maxLength":2048,"format":"uri","description":"An absolute http(s) URL on one of the organization's websites: the page whose behaviour the question is about (a product page, a search URL such as /search?q=odor, or the home page)."}},{"name":"surfaces","in":"query","required":false,"description":"What to read besides the page and what it runs on: robots (/robots.txt), llms (/llms.txt), markup (title, meta robots, canonical, alternate links, structured data types), forms (form actions and fields, such as site search), negotiation (whether the page answers Accept: text/markdown), rendered (the page's text after a browser runs it). Use [] for the page and its platform alone.","schema":{"default":[],"maxItems":6,"type":"array","items":{"type":"string","enum":["robots","llms","markup","forms","negotiation","rendered"]},"description":"What to read besides the page and what it runs on: robots (/robots.txt), llms (/llms.txt), markup (title, meta robots, canonical, alternate links, structured data types), forms (form actions and fields, such as site search), negotiation (whether the page answers Accept: text/markdown), rendered (the page's text after a browser runs it). Use [] for the page and its platform alone."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InspectorSiteInspectionsRunResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/campaigns":{"get":{"operationId":"discovery.campaigns.list.v1","summary":"List campaigns","description":"List the organization's Discovery campaigns, most recently updated first: the ones it funds, from the Start that funded them, and the ones Point11 runs and published to it. A first campaign still being set up (its target not yet settled) is omitted until setup settles it. Pass the returned nextCursor to continue.","tags":["discovery"],"x-cli-name":"discovery-campaigns-list","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"status","in":"query","required":false,"description":"Only campaigns in these lifecycle statuses; omit for every one.","schema":{"description":"Only campaigns in these lifecycle statuses; omit for every one.","minItems":1,"maxItems":4,"type":"array","items":{"type":"string","enum":["active","paused","archived","deleted"]}}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryCampaignsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/campaign-settings/{id}":{"get":{"operationId":"discovery.campaign-settings.get.v1","summary":"Get campaign settings","description":"Get a Discovery campaign's saved setup, active, paused or archived alike: its assistants, precision, customer target and pool, audience or customer targeting, and store locations. Its schedule, progress and standing are campaigns_summaries_get_v2's.","tags":["discovery"],"x-cli-name":"discovery-campaign-settings-get","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryCampaignSettingsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/campaign-settings-quotes/{id}":{"get":{"operationId":"discovery.campaign-settings-quotes.get.v1","summary":"Get campaign settings quotes","description":"Deprecated: use discovery.campaign-settings-quotes.get.v2 (discovery_campaign_settings_quotes_get_v2), which takes no audience, targetedGroupIds or removeCustomersOutsideAudience: a campaign's audiences are fixed at launch. This version still quotes a change to them. Review a Save of a Discovery campaign's settings before making it, writing nothing: each change and when it starts (from the next run; a run under way finishes on what it reserved), the change in estimated monthly conversations at today's price with any one-time work, Billing's answer to the extra work, how the change reaches results, and who a lower customer count removes. Pass the settingsRevision discovery.campaign-settings.get returned as expectedSettingsRevision; refused when the settings changed since. `id` is the campaign's id.","deprecated":true,"tags":["discovery"],"x-cli-name":"discovery-campaign-settings-quotes-get","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"expectedSettingsRevision","in":"query","required":true,"description":"The settingsRevision the settings read (or a quote) returned.","schema":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The settingsRevision the settings read (or a quote) returned."}},{"name":"name","in":"query","required":false,"description":"The campaign's new name.","schema":{"type":"string","minLength":1,"maxLength":120,"description":"The campaign's new name."}},{"name":"engines","in":"query","required":false,"description":"The assistants the campaign asks from its next run: the whole set, at least one. Add, remove or swap; past conversations stay.","schema":{"description":"The assistants the campaign asks from its next run: the whole set, at least one. Add, remove or swap; past conversations stay.","minItems":1,"maxItems":4,"type":"array","items":{"type":"string","enum":["chatgpt","gemini","claude","grok"]}}},{"name":"engineCatchUp","in":"query","required":false,"description":"When an assistant is added: also run it once, within a day, for the customers this month's runs already refreshed (true when omitted), so its results are complete this month.","schema":{"description":"When an assistant is added: also run it once, within a day, for the customers this month's runs already refreshed (true when omitted), so its results are complete this month.","type":"boolean"}},{"name":"customerCount","in":"query","required":false,"description":"How many customers it runs: the campaign's total, or, on a store campaign, the customers per store. Raising it adds eligible customers, then generates the rest; lowering it removes the newest joined first unless removeCustomerIds names who leaves.","schema":{"description":"How many customers it runs: the campaign's total, or, on a store campaign, the customers per store. Raising it adds eligible customers, then generates the rest; lowering it removes the newest joined first unless removeCustomerIds names who leaves.","type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},{"name":"addCustomerIds","in":"query","required":false,"description":"Customers to add; each joins this month's calendar.","schema":{"description":"Customers to add; each joins this month's calendar.","maxItems":1000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},{"name":"removeCustomerIds","in":"query","required":false,"description":"Customers to remove; each leaves every later run at once and keeps its history.","schema":{"description":"Customers to remove; each leaves every later run at once and keeps its history.","maxItems":1000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},{"name":"audience","in":"query","required":false,"description":"Who can be added: every eligible customer (all) or members of targetedGroupIds (groups). It never resamples the current customers.","schema":{"description":"Who can be added: every eligible customer (all) or members of targetedGroupIds (groups). It never resamples the current customers.","type":"string","enum":["all","groups"]}},{"name":"targetedGroupIds","in":"query","required":false,"description":"The audiences, with audience groups.","schema":{"description":"The audiences, with audience groups.","maxItems":1000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},{"name":"removeCustomersOutsideAudience","in":"query","required":false,"description":"With a new audience: also remove the current customers outside it.","schema":{"description":"With a new audience: also remove the current customers outside it.","type":"boolean"}},{"name":"removeStoreKeys","in":"query","required":false,"description":"Stores to stop measuring, by key: their customers leave at once and their history stays.","schema":{"description":"Stores to stop measuring, by key: their customers leave at once and their history stays.","maxItems":309,"type":"array","items":{"type":"string","minLength":1,"maxLength":2000}}},{"name":"addStores","in":"query","required":false,"description":"Stores to add, each one JSON-encoded store pick as the update takes it.","schema":{"description":"Stores to add, each one JSON-encoded store pick as the update takes it.","maxItems":309,"type":"array","items":{"type":"string","minLength":2,"maxLength":8000}}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryCampaignSettingsQuotesGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/campaign-settings-quotes-v2/{id}":{"get":{"operationId":"discovery.campaign-settings-quotes.get.v2","summary":"Get campaign settings quotes (v2)","description":"Review a Save of a Discovery campaign's settings before making it, writing nothing: each change and when it starts (from the next run; a run under way finishes on what it reserved), the change in estimated monthly conversations at today's price with any one-time work, Billing's answer to the extra work, how the change reaches results, and who a lower customer count removes. Pass the settingsRevision discovery_campaign_settings_get returned as expectedSettingsRevision; refused when the settings changed since. `id` is the campaign's id.","tags":["discovery"],"x-cli-name":"discovery-campaign-settings-quotes-get-v2","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"expectedSettingsRevision","in":"query","required":true,"description":"The settingsRevision the settings read (or a quote) returned.","schema":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The settingsRevision the settings read (or a quote) returned."}},{"name":"name","in":"query","required":false,"description":"The campaign's new name.","schema":{"type":"string","minLength":1,"maxLength":120,"description":"The campaign's new name."}},{"name":"engines","in":"query","required":false,"description":"The assistants the campaign asks from its next run: the whole set, at least one. Add, remove or swap; past conversations stay.","schema":{"description":"The assistants the campaign asks from its next run: the whole set, at least one. Add, remove or swap; past conversations stay.","minItems":1,"maxItems":4,"type":"array","items":{"type":"string","enum":["chatgpt","gemini","claude","grok"]}}},{"name":"engineCatchUp","in":"query","required":false,"description":"When an assistant is added: also run it once, within a day, for the customers this month's runs already refreshed (true when omitted), so its results are complete this month.","schema":{"description":"When an assistant is added: also run it once, within a day, for the customers this month's runs already refreshed (true when omitted), so its results are complete this month.","type":"boolean"}},{"name":"customerCount","in":"query","required":false,"description":"How many customers it runs: the campaign's total, or, on a store campaign, the customers per store. Raising it adds eligible customers, then generates the rest; lowering it removes the newest joined first unless removeCustomerIds names who leaves.","schema":{"description":"How many customers it runs: the campaign's total, or, on a store campaign, the customers per store. Raising it adds eligible customers, then generates the rest; lowering it removes the newest joined first unless removeCustomerIds names who leaves.","type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},{"name":"addCustomerIds","in":"query","required":false,"description":"Customers to add; each joins this month's calendar.","schema":{"description":"Customers to add; each joins this month's calendar.","maxItems":1000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},{"name":"removeCustomerIds","in":"query","required":false,"description":"Customers to remove; each leaves every later run at once and keeps its history.","schema":{"description":"Customers to remove; each leaves every later run at once and keeps its history.","maxItems":1000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},{"name":"removeStoreKeys","in":"query","required":false,"description":"Stores to stop measuring, by key: their customers leave at once and their history stays.","schema":{"description":"Stores to stop measuring, by key: their customers leave at once and their history stays.","maxItems":309,"type":"array","items":{"type":"string","minLength":1,"maxLength":2000}}},{"name":"addStores","in":"query","required":false,"description":"Stores to add, each one JSON-encoded store pick as the update takes it.","schema":{"description":"Stores to add, each one JSON-encoded store pick as the update takes it.","maxItems":309,"type":"array","items":{"type":"string","minLength":2,"maxLength":8000}}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryCampaignSettingsQuotesGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/campaign-settings/update":{"post":{"operationId":"discovery.campaign-settings.update.v1","summary":"Update campaign settings","description":"Deprecated: use discovery.campaign-settings.update.v2 (discovery_campaign_settings_update_v2), which takes no audience, targetedGroupIds or removeCustomersOutsideAudience: a campaign's audiences are fixed at launch. This version still changes them. Save a Discovery campaign's settings in place, all or nothing: its name, assistants, customers (who and how many), audiences and a store campaign's stores. Results continue on the same campaign and take in the change over its next 30 days; changes reach the next run, and a run under way finishes on what it reserved. Nothing is charged at Save: delivered conversations accrue against the plan. Pass expectedSettingsRevision from discovery.campaign-settings.get; a Save whose settings moved since is refused (STALE_WRITE). Pass reviewedEstimate from discovery.campaign-settings-quotes.get to also refuse one whose estimate moved, or null to save at the current estimate. The website never changes. A person confirms it.","deprecated":true,"tags":["discovery"],"x-cli-name":"discovery-campaign-settings-update","x-point11-scope":"discovery:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}},{"name":"Point11-Confirm","in":"header","required":true,"description":"Explicit human confirmation of this operation's effect.","schema":{"type":"string","enum":["true"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryCampaignSettingsUpdateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryCampaignSettingsUpdateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/campaign-settings/update-v2":{"post":{"operationId":"discovery.campaign-settings.update.v2","summary":"Update campaign settings (v2)","description":"Save a Discovery campaign's settings in place, all or nothing: its name, assistants, customers (who and how many) and a store campaign's stores. Results continue on the same campaign and take in the change over its next 30 days; changes reach the next run, and a run under way finishes on what it reserved. Nothing is charged at Save: delivered conversations accrue against the plan, and a Save adding work Billing would not admit is refused. Pass expectedSettingsRevision from discovery_campaign_settings_get; a Save whose settings moved since is refused (STALE_WRITE). Pass reviewedEstimate from discovery_campaign_settings_quotes_get_v2 to also refuse one whose estimate moved, or null to save at the current estimate. The website and the audiences it launched with never change. A person confirms it.","tags":["discovery"],"x-cli-name":"discovery-campaign-settings-update-v2","x-point11-scope":"discovery:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}},{"name":"Point11-Confirm","in":"header","required":true,"description":"Explicit human confirmation of this operation's effect.","schema":{"type":"string","enum":["true"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryCampaignSettingsUpdateV2Request"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryCampaignSettingsUpdateV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/precision-quotes/{id}":{"get":{"operationId":"discovery.precision-quotes.get.v1","summary":"Get precision quotes","description":"Deprecated: use campaigns.precision-quotes.get.v1 (campaigns_precision_quotes_get), which prices an order for one reading's group. Price a precision increase for a campaign before ordering it: the price of one conversation, the campaign's panel, assistants, and lanes, and whether the precision control is available (with the reason when it is not).","deprecated":true,"tags":["discovery"],"x-cli-name":"discovery-precision-quotes-get","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The campaign id."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryPrecisionQuotesGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/precision-increases":{"get":{"operationId":"discovery.precision-increases.list.v1","summary":"List precision increases","description":"Deprecated: use campaigns.precision-orders.list.v1 (campaigns_precision_orders_list); this version lists each order with the margin of error its rung was ordered at. List a campaign's precision orders, newest first, with each order's progress: customers generated, added, and interviewed, and its state; an order over buckets this version cannot name is left out.","deprecated":true,"tags":["discovery"],"x-cli-name":"discovery-precision-increases-list","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"campaignId","in":"query","required":true,"description":"The campaign whose precision orders to list.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The campaign whose precision orders to list."}},{"name":"newestPerFocus","in":"query","required":false,"description":"List only each generation focus's newest order (the one its cohort's progress shows), newest first.","schema":{"description":"List only each generation focus's newest order (the one its cohort's progress shows), newest first.","type":"boolean"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryPrecisionIncreasesListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/precision-increases-v2":{"get":{"operationId":"discovery.precision-increases.list.v2","summary":"List precision increases (v2)","description":"Deprecated: use campaigns.precision-orders.list.v1 (campaigns_precision_orders_list), which lists each group's newest order with the customers it filled from the eligible pool. List a campaign's precision orders, newest first, with each order's progress: customers generated, added, and interviewed, and its state; an order over buckets this version cannot name is left out.","deprecated":true,"tags":["discovery"],"x-cli-name":"discovery-precision-increases-list-v2","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"campaignId","in":"query","required":true,"description":"The campaign whose precision orders to list.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The campaign whose precision orders to list."}},{"name":"newestPerFocus","in":"query","required":false,"description":"List only each generation focus's newest order (the one its cohort's progress shows), newest first.","schema":{"description":"List only each generation focus's newest order (the one its cohort's progress shows), newest first.","type":"boolean"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryPrecisionIncreasesListV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/coverage-quotes/{id}":{"get":{"operationId":"discovery.coverage-quotes.get.v1","summary":"Get coverage quotes","description":"Deprecated: use discovery.campaign-settings-quotes.get.v2 (discovery_campaign_settings_quotes_get_v2), which reviews any change to a campaign's assistants (add, remove or swap) with every other setting of one Save; this version answers what one more assistant adds, as the quote of the Save that adds it. Price adding AI assistants to a campaign before ordering it: the price of one conversation, the assistants that can be added, and the monthly change each adds. Refused, with the reason in details.control, where that Save would be.","deprecated":true,"tags":["discovery"],"x-cli-name":"discovery-coverage-quotes-get","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The campaign id."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryCoverageQuotesGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/location-quotes/{id}":{"get":{"operationId":"discovery.location-quotes.get.v1","summary":"Get location quotes","description":"Deprecated: use discovery.campaign-settings-quotes.get.v2 (discovery_campaign_settings_quotes_get_v2), which reviews adding the stores themselves (addStores) with every other setting of one Save; this version prices a count of added locations, as it always has. Price adding locations to a physical-location campaign before committing: the monthly change for the given number of added locations.","deprecated":true,"tags":["discovery"],"x-cli-name":"discovery-location-quotes-get","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The location campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The location campaign id."}},{"name":"addedLocationCount","in":"query","required":true,"description":"Locations to add.","schema":{"type":"integer","minimum":1,"maximum":309,"description":"Locations to add."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryLocationQuotesGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/brand-matchups/{id}":{"get":{"operationId":"discovery.brand-matchups.get.v1","summary":"Get brand matchups","description":"Deprecated: use discovery.brand-matchups.get.v2 (discovery_brand_matchups_get_v2), which reads the campaign's results window and answers a pair's evidence as its decided matchups alone; this version reads the one run `dispatchId` names, its evidence `status` none or supported, `confident` false and `wilsonLowerBound` 0. Read the head-to-head record between two brands in a campaign's run: wins, win rate, decisiveness, evidence strength, and why the loser loses, optionally within one cohort.","deprecated":true,"tags":["discovery"],"x-cli-name":"discovery-brand-matchups-get","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dispatchId","in":"query","required":true,"description":"The completed dispatch the map was drawn from.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The completed dispatch the map was drawn from."}},{"name":"segments","in":"query","required":false,"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.","schema":{"maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."},"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch."}},{"name":"brandAKey","in":"query","required":true,"description":"A brand's normalized key (trimmed, single-spaced, lowercase name).","schema":{"type":"string","minLength":1,"maxLength":160,"description":"A brand's normalized key (trimmed, single-spaced, lowercase name)."}},{"name":"brandBKey","in":"query","required":true,"description":"A brand's normalized key (trimmed, single-spaced, lowercase name).","schema":{"type":"string","minLength":1,"maxLength":160,"description":"A brand's normalized key (trimmed, single-spaced, lowercase name)."}},{"name":"cohortDimension","in":"query","required":false,"description":"Reads the matchup inside one cohort; omit both cohort fields to read every conversation.","schema":{"description":"Reads the matchup inside one cohort; omit both cohort fields to read every conversation.","type":"string","enum":["decision-factors","audiences","engines"]}},{"name":"cohortValue","in":"query","required":false,"description":"The cohort member's id on cohortDimension.","schema":{"type":"string","minLength":1,"maxLength":300,"description":"The cohort member's id on cohortDimension."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryBrandMatchupsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/brand-matchups-v2/{id}":{"get":{"operationId":"discovery.brand-matchups.get.v2","summary":"Get brand matchups (v2)","description":"Read the head-to-head record between two brands in a campaign, over the conversations dated in the 30 days ending its results window's as-of day: wins, win rate, decisiveness, decided matchups, and why the loser loses, optionally within one cohort.","tags":["discovery"],"x-cli-name":"discovery-brand-matchups-get-v2","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"segments","in":"query","required":false,"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.","schema":{"maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."},"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch."}},{"name":"brandAKey","in":"query","required":true,"description":"A brand's normalized key (trimmed, single-spaced, lowercase name).","schema":{"type":"string","minLength":1,"maxLength":160,"description":"A brand's normalized key (trimmed, single-spaced, lowercase name)."}},{"name":"brandBKey","in":"query","required":true,"description":"A brand's normalized key (trimmed, single-spaced, lowercase name).","schema":{"type":"string","minLength":1,"maxLength":160,"description":"A brand's normalized key (trimmed, single-spaced, lowercase name)."}},{"name":"cohortDimension","in":"query","required":false,"description":"Reads the matchup inside one cohort; omit both cohort fields to read every conversation.","schema":{"description":"Reads the matchup inside one cohort; omit both cohort fields to read every conversation.","type":"string","enum":["decision-factors","audiences","engines"]}},{"name":"cohortValue","in":"query","required":false,"description":"The cohort member's id on cohortDimension.","schema":{"type":"string","minLength":1,"maxLength":300,"description":"The cohort member's id on cohortDimension."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryBrandMatchupsGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/brand-matchup-breakdowns/{id}":{"get":{"operationId":"discovery.brand-matchup-breakdowns.get.v1","summary":"Get brand matchup breakdowns","description":"Deprecated: use discovery.brand-matchup-breakdowns.get.v2 (discovery_brand_matchup_breakdowns_get_v2), which reads the campaign's results window and lists every value with a decided matchup; this version reads the one run `dispatchId` names, each row's evidence `status` none or supported, `confident` false and `wilsonLowerBound` 0. Break a two-brand head-to-head record down by decision factor, audience, or AI engine, with each value's record and its difference from the overall record.","deprecated":true,"tags":["discovery"],"x-cli-name":"discovery-brand-matchup-breakdowns-get","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dispatchId","in":"query","required":true,"description":"The completed dispatch the map was drawn from.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The completed dispatch the map was drawn from."}},{"name":"segments","in":"query","required":false,"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.","schema":{"maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."},"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch."}},{"name":"brandAKey","in":"query","required":true,"description":"A brand's normalized key (trimmed, single-spaced, lowercase name).","schema":{"type":"string","minLength":1,"maxLength":160,"description":"A brand's normalized key (trimmed, single-spaced, lowercase name)."}},{"name":"brandBKey","in":"query","required":true,"description":"A brand's normalized key (trimmed, single-spaced, lowercase name).","schema":{"type":"string","minLength":1,"maxLength":160,"description":"A brand's normalized key (trimmed, single-spaced, lowercase name)."}},{"name":"cohortDimension","in":"query","required":false,"description":"Reads the matchup inside one cohort; omit both cohort fields to read every conversation.","schema":{"description":"Reads the matchup inside one cohort; omit both cohort fields to read every conversation.","type":"string","enum":["decision-factors","audiences","engines"]}},{"name":"cohortValue","in":"query","required":false,"description":"The cohort member's id on cohortDimension.","schema":{"type":"string","minLength":1,"maxLength":300,"description":"The cohort member's id on cohortDimension."}},{"name":"dimension","in":"query","required":true,"description":"The dimension a matchup splits by.","schema":{"type":"string","enum":["decision-factors","audiences","engines"],"description":"The dimension a matchup splits by."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryBrandMatchupBreakdownsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/brand-matchup-breakdowns-v2/{id}":{"get":{"operationId":"discovery.brand-matchup-breakdowns.get.v2","summary":"Get brand matchup breakdowns (v2)","description":"Break a two-brand head-to-head record over a campaign's results window down by decision factor, audience, or AI engine, with each value's record, its decided matchups, and its difference from the overall record.","tags":["discovery"],"x-cli-name":"discovery-brand-matchup-breakdowns-get-v2","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"segments","in":"query","required":false,"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.","schema":{"maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."},"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch."}},{"name":"brandAKey","in":"query","required":true,"description":"A brand's normalized key (trimmed, single-spaced, lowercase name).","schema":{"type":"string","minLength":1,"maxLength":160,"description":"A brand's normalized key (trimmed, single-spaced, lowercase name)."}},{"name":"brandBKey","in":"query","required":true,"description":"A brand's normalized key (trimmed, single-spaced, lowercase name).","schema":{"type":"string","minLength":1,"maxLength":160,"description":"A brand's normalized key (trimmed, single-spaced, lowercase name)."}},{"name":"cohortDimension","in":"query","required":false,"description":"Reads the matchup inside one cohort; omit both cohort fields to read every conversation.","schema":{"description":"Reads the matchup inside one cohort; omit both cohort fields to read every conversation.","type":"string","enum":["decision-factors","audiences","engines"]}},{"name":"cohortValue","in":"query","required":false,"description":"The cohort member's id on cohortDimension.","schema":{"type":"string","minLength":1,"maxLength":300,"description":"The cohort member's id on cohortDimension."}},{"name":"dimension","in":"query","required":true,"description":"The dimension a matchup splits by.","schema":{"type":"string","enum":["decision-factors","audiences","engines"],"description":"The dimension a matchup splits by."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryBrandMatchupBreakdownsGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/brand-cohorts/{id}":{"get":{"operationId":"discovery.brand-cohorts.get.v1","summary":"Get brand cohorts","description":"Deprecated: use discovery.brand-cohorts.get.v2 (discovery_brand_cohorts_get_v2), which reads the campaign's results window; this version reads the one run `dispatchId` names, every arc's `confident` false. Read the head-to-head ring for a set of brands within one cohort (a decision factor, audience, or AI engine): their order and pairwise records.","deprecated":true,"tags":["discovery"],"x-cli-name":"discovery-brand-cohorts-get","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dispatchId","in":"query","required":true,"description":"The completed dispatch the map was drawn from.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The completed dispatch the map was drawn from."}},{"name":"segments","in":"query","required":false,"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.","schema":{"maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."},"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch."}},{"name":"cohortDimension","in":"query","required":true,"description":"The cohort's dimension; give it with cohortValue.","schema":{"type":"string","enum":["decision-factors","audiences","engines"],"description":"The cohort's dimension; give it with cohortValue."}},{"name":"cohortValue","in":"query","required":true,"description":"The cohort member's id on cohortDimension.","schema":{"type":"string","minLength":1,"maxLength":300,"description":"The cohort member's id on cohortDimension."}},{"name":"memberKeys","in":"query","required":true,"description":"The ring's brands, 1 to 16 unique normalized keys.","schema":{"minItems":1,"maxItems":16,"type":"array","items":{"type":"string","minLength":1,"maxLength":160,"description":"A brand's normalized key (trimmed, single-spaced, lowercase name)."},"description":"The ring's brands, 1 to 16 unique normalized keys."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryBrandCohortsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/brand-cohorts-v2/{id}":{"get":{"operationId":"discovery.brand-cohorts.get.v2","summary":"Get brand cohorts (v2)","description":"Read the head-to-head ring for a set of brands within one cohort (a decision factor, audience, or AI engine) over a campaign's results window: their order and pairwise records.","tags":["discovery"],"x-cli-name":"discovery-brand-cohorts-get-v2","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"segments","in":"query","required":false,"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.","schema":{"maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."},"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch."}},{"name":"cohortDimension","in":"query","required":true,"description":"The cohort's dimension; give it with cohortValue.","schema":{"type":"string","enum":["decision-factors","audiences","engines"],"description":"The cohort's dimension; give it with cohortValue."}},{"name":"cohortValue","in":"query","required":true,"description":"The cohort member's id on cohortDimension.","schema":{"type":"string","minLength":1,"maxLength":300,"description":"The cohort member's id on cohortDimension."}},{"name":"memberKeys","in":"query","required":true,"description":"The ring's brands, 1 to 16 unique normalized keys.","schema":{"minItems":1,"maxItems":16,"type":"array","items":{"type":"string","minLength":1,"maxLength":160,"description":"A brand's normalized key (trimmed, single-spaced, lowercase name)."},"description":"The ring's brands, 1 to 16 unique normalized keys."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryBrandCohortsGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/competitor-reasons/{id}":{"get":{"operationId":"discovery.competitor-reasons.get.v1","summary":"Get competitor reasons","description":"Deprecated: use discovery.competitor-reasons.get.v2 (discovery_competitor_reasons_get_v2), which reads the results window the caller names and answers each reason's trend as one point per day; this version refuses unless that window's newest measuring run is the `dispatchId` named, and labels a trend's days with a value. Read why the campaign's brand wins and loses against one competitor, with each reason's frequency and trend. An empty answer means the run records no reasons for that competitor.","deprecated":true,"tags":["discovery"],"x-cli-name":"discovery-competitor-reasons-get","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dispatchId","in":"query","required":true,"description":"The dispatch the caller read; a newer one refuses.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The dispatch the caller read; a newer one refuses."}},{"name":"dateRange","in":"query","required":true,"description":"The window the caller resolved: `all` or `yyyy-MM-dd..yyyy-MM-dd`.","schema":{"type":"string","minLength":1,"maxLength":40,"description":"The window the caller resolved: `all` or `yyyy-MM-dd..yyyy-MM-dd`."}},{"name":"segments","in":"query","required":false,"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.","schema":{"maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."},"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch."}},{"name":"brandName","in":"query","required":false,"description":"The brand whose reasons are read, as the brand map names it; null (the default) reads the campaign's own brand.","schema":{"default":null,"description":"The brand whose reasons are read, as the brand map names it; null (the default) reads the campaign's own brand.","anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]}},{"name":"competitorKey","in":"query","required":true,"description":"The rival's normalized brand key (trimmed, single-spaced, lowercase name).","schema":{"type":"string","minLength":1,"maxLength":200,"description":"The rival's normalized brand key (trimmed, single-spaced, lowercase name)."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryCompetitorReasonsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/competitor-reasons-v2/{id}":{"get":{"operationId":"discovery.competitor-reasons.get.v2","summary":"Get competitor reasons (v2)","description":"Deprecated: use discovery.competitor-reasons.get.v3 (discovery_competitor_reasons_get_v3), which names no lightSrc or darkSrc on a leading icon: a favicon is one image for both themes, src. This version answers the same and names both, never sent. Read why the campaign's brand wins and loses against one competitor over the conversations dated in the 30 days ending its results window's as-of day, with each reason's count and its daily trend (null for a day whose window holds no conversation). An empty answer means the window records no reasons for that competitor.","deprecated":true,"tags":["discovery"],"x-cli-name":"discovery-competitor-reasons-get-v2","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"segments","in":"query","required":false,"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.","schema":{"maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."},"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch."}},{"name":"brandName","in":"query","required":false,"description":"The brand whose reasons are read, as the brand map names it; null (the default) reads the campaign's own brand.","schema":{"default":null,"description":"The brand whose reasons are read, as the brand map names it; null (the default) reads the campaign's own brand.","anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]}},{"name":"competitorKey","in":"query","required":true,"description":"The rival's normalized brand key (trimmed, single-spaced, lowercase name).","schema":{"type":"string","minLength":1,"maxLength":200,"description":"The rival's normalized brand key (trimmed, single-spaced, lowercase name)."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryCompetitorReasonsGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/competitor-reasons-v3/{id}":{"get":{"operationId":"discovery.competitor-reasons.get.v3","summary":"Get competitor reasons (v3)","description":"Read why the campaign's brand wins and loses against one competitor over the conversations dated in the 30 days ending its results window's as-of day, with each reason's count and its daily trend (null for a day whose window holds no conversation). An empty answer means the window records no reasons for that competitor.","tags":["discovery"],"x-cli-name":"discovery-competitor-reasons-get-v3","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"segments","in":"query","required":false,"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.","schema":{"maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."},"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch."}},{"name":"brandName","in":"query","required":false,"description":"The brand whose reasons are read, as the brand map names it; null (the default) reads the campaign's own brand.","schema":{"default":null,"description":"The brand whose reasons are read, as the brand map names it; null (the default) reads the campaign's own brand.","anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]}},{"name":"competitorKey","in":"query","required":true,"description":"The rival's normalized brand key (trimmed, single-spaced, lowercase name).","schema":{"type":"string","minLength":1,"maxLength":200,"description":"The rival's normalized brand key (trimmed, single-spaced, lowercase name)."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryCompetitorReasonsGetV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/segment-options-v3/{id}":{"get":{"operationId":"discovery.segment-options.get.v3","summary":"Get segment options (v3)","description":"List the segments a campaign's results can be narrowed to, by axis: customer attributes (gender among them), products (the business's revenue lines), engines, competitors, topics, sentiment and stores, with each option's id and label.","tags":["discovery"],"x-cli-name":"discovery-segment-options-get-v3","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"brandPerspective","in":"query","required":false,"description":"Read the competitor axis as this brand (one of the campaign's brands). Omit for your own.","schema":{"description":"Read the competitor axis as this brand (one of the campaign's brands). Omit for your own.","anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoverySegmentOptionsGetV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/overview-reports-v4/{id}":{"get":{"operationId":"discovery.overview-reports.get.v4","summary":"Get overview reports (v4)","description":"Deprecated: use discovery.overview-reports.get.v5 (discovery_overview_reports_get_v5), which answers no faviconLightUrl or faviconDarkUrl: a favicon is one image for both themes, faviconUrl. This version answers the same with both, always null. Read a campaign's overview: brand share, win rate, and revenue influence KPIs with trends, competitive position, why the brand wins and loses, and conversation totals, over the campaign's results window (`scope.window`): every value as of the window's as-of day, averaged over the conversations dated in the 30 days ending it, every trend one point per day (null for a day whose window holds no conversation the value counts), and every change the value minus its value 30 days before the as-of day (null without one). A share or win rate nothing in scope measured is { kind: absent, reason }, never 0.","deprecated":true,"tags":["discovery"],"x-cli-name":"discovery-overview-reports-get-v4","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"brandPerspective","in":"query","required":false,"description":"Read the results as this brand (one of the campaign's brands). Omit for your own.","schema":{"description":"Read the results as this brand (one of the campaign's brands). Omit for your own.","anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]}},{"name":"segments","in":"query","required":false,"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.","schema":{"maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."},"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryOverviewReportsGetV4Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/overview-reports-v5/{id}":{"get":{"operationId":"discovery.overview-reports.get.v5","summary":"Get overview reports (v5)","description":"Read a campaign's overview: brand share, win rate, and revenue influence KPIs with trends, competitive position, why the brand wins and loses, and conversation totals, over the campaign's results window (`scope.window`): every value as of the window's as-of day, averaged over the conversations dated in the 30 days ending it, every trend one point per day (null for a day whose window holds no conversation the value counts), and every change the value minus its value 30 days before the as-of day (null without one). A share or win rate nothing in scope measured is { kind: absent, reason }, never 0.","tags":["discovery"],"x-cli-name":"discovery-overview-reports-get-v5","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"brandPerspective","in":"query","required":false,"description":"Read the results as this brand (one of the campaign's brands). Omit for your own.","schema":{"description":"Read the results as this brand (one of the campaign's brands). Omit for your own.","anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]}},{"name":"segments","in":"query","required":false,"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.","schema":{"maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."},"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryOverviewReportsGetV5Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/revenue-reports-v4/{id}":{"get":{"operationId":"discovery.revenue-reports.get.v4","summary":"Get revenue reports (v4)","description":"Read a campaign's Products report: for each product of the business (a revenue line: lines[].id), its brand share, win rate, and modeled revenue influence, with drivers and trends, over the campaign's results window (`scope.window`): every value as of the window's as-of day, averaged over the conversations dated in the 30 days ending it, every trend one point per day (null for a day whose window holds no conversation the value counts), and every change the value minus its value 30 days before the as-of day (null without one). A share or win rate nothing in scope measured is { kind: absent, reason }, never 0.","tags":["discovery"],"x-cli-name":"discovery-revenue-reports-get-v4","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"brandPerspective","in":"query","required":false,"description":"Read the results as this brand (one of the campaign's brands). Omit for your own.","schema":{"description":"Read the results as this brand (one of the campaign's brands). Omit for your own.","anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]}},{"name":"segments","in":"query","required":false,"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.","schema":{"maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."},"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch."}},{"name":"history","in":"query","required":false,"description":"Read every daily trend. Default true; false reads the as-of window and the one 30 days before it alone: lineSeries, segmentCountSeries and every driver's series are empty, and every change stays.","schema":{"description":"Read every daily trend. Default true; false reads the as-of window and the one 30 days before it alone: lineSeries, segmentCountSeries and every driver's series are empty, and every change stays.","type":"boolean"}},{"name":"drivers","in":"query","required":false,"description":"Read each line's win and loss reasons. Default true; false leaves `drivers` empty.","schema":{"description":"Read each line's win and loss reasons. Default true; false leaves `drivers` empty.","type":"boolean"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryRevenueReportsGetV4Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/audience-reports-v4/{id}":{"get":{"operationId":"discovery.audience-reports.get.v4","summary":"Get audience reports (v4)","description":"Deprecated: use discovery.audience-reports.get.v5 (discovery_audience_reports_get_v5), which carries no audience `topTopic`, `strongestAudiences` or `losingGround`: nothing measures them. This version reads the same report and answers every audience's `topTopic` as an empty string and `strongestAudiences` and `losingGround` as empty lists. Read a campaign's audience report: brand share, win rate, top competitor, and win and loss drivers for each audience, over the campaign's results window (`scope.window`): every value as of the window's as-of day, averaged over the conversations dated in the 30 days ending it, every trend one point per day (null for a day whose window holds no conversation the value counts), and every change the value minus its value 30 days before the as-of day (null without one). A share or win rate nothing in scope measured is { kind: absent, reason }, never 0.","deprecated":true,"tags":["discovery"],"x-cli-name":"discovery-audience-reports-get-v4","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"brandPerspective","in":"query","required":false,"description":"Read the results as this brand (one of the campaign's brands). Omit for your own.","schema":{"description":"Read the results as this brand (one of the campaign's brands). Omit for your own.","anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]}},{"name":"segments","in":"query","required":false,"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.","schema":{"maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."},"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryAudienceReportsGetV4Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/audience-reports-v5/{id}":{"get":{"operationId":"discovery.audience-reports.get.v5","summary":"Get audience reports (v5)","description":"Read a campaign's audience report: brand share, win rate, top competitor, and win and loss drivers for each audience, over the campaign's results window (`scope.window`): every value as of the window's as-of day, averaged over the conversations dated in the 30 days ending it, every trend one point per day (null for a day whose window holds no conversation the value counts), and every change the value minus its value 30 days before the as-of day (null without one). A share or win rate nothing in scope measured is { kind: absent, reason }, never 0.","tags":["discovery"],"x-cli-name":"discovery-audience-reports-get-v5","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"brandPerspective","in":"query","required":false,"description":"Read the results as this brand (one of the campaign's brands). Omit for your own.","schema":{"description":"Read the results as this brand (one of the campaign's brands). Omit for your own.","anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]}},{"name":"segments","in":"query","required":false,"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.","schema":{"maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."},"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryAudienceReportsGetV5Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/segment-win-rates/{id}":{"get":{"operationId":"discovery.segment-win-rates.get.v1","summary":"Get segment win rates","description":"Deprecated: use discovery.segment-win-rates.get.v2 (discovery_segment_win_rates_get_v2), which answers the results window its rates read in `scope.window` and an all-up rate nothing in scope measured as { kind: absent, reason }; this version reads the same rates, names in `scope.dispatchId` the newest run that measured a conversation of the window's last 30 days, reads an absent all-up rate as 0, and labels the window's as-of day in `measuredOn` (\"Oct 9\"). Read a campaign's brand win rate for each revenue line and each audience, with each split's all-up win rate, exactly as discovery.revenue-reports.get and discovery.audience-reports.get state them for the same window, read as the campaign's own brand. Carries no trend, driver or competitor: the reports carry those.","deprecated":true,"tags":["discovery"],"x-cli-name":"discovery-segment-win-rates-get","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoverySegmentWinRatesGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/segment-win-rates-v2/{id}":{"get":{"operationId":"discovery.segment-win-rates.get.v2","summary":"Get segment win rates (v2)","description":"Read a campaign's brand win rate for each revenue line, each audience and each channel, with each split's all-up win rate, as of its results window's as-of day (`scope.window`), exactly as discovery_revenue_reports_get_v4, discovery_audience_reports_get_v5 and discovery_channel_reports_get_v4 state them for the same window, read as the campaign's own brand. Carries no trend, driver or competitor: the reports carry those.","tags":["discovery"],"x-cli-name":"discovery-segment-win-rates-get-v2","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoverySegmentWinRatesGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/channel-reports-v4/{id}":{"get":{"operationId":"discovery.channel-reports.get.v4","summary":"Get channel reports (v4)","description":"Read a campaign's channel report: brand share, win rate, top competitor, and win and loss drivers for each channel, over the campaign's results window (`scope.window`): every value as of the window's as-of day, averaged over the conversations dated in the 30 days ending it, every trend one point per day (null for a day whose window holds no conversation the value counts), and every change the value minus its value 30 days before the as-of day (null without one). A share or win rate nothing in scope measured is { kind: absent, reason }, never 0.","tags":["discovery"],"x-cli-name":"discovery-channel-reports-get-v4","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"brandPerspective","in":"query","required":false,"description":"Read the results as this brand (one of the campaign's brands). Omit for your own.","schema":{"description":"Read the results as this brand (one of the campaign's brands). Omit for your own.","anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]}},{"name":"segments","in":"query","required":false,"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.","schema":{"maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."},"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryChannelReportsGetV4Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/topic-reports-v4/{id}":{"get":{"operationId":"discovery.topic-reports.get.v4","summary":"Get topic reports (v4)","description":"Read a campaign's topic report: each conversation topic's share, brand win rate against the portfolio, top competitor, and win and loss drivers, over the campaign's results window (`scope.window`): every value as of the window's as-of day, averaged over the conversations dated in the 30 days ending it, every trend one point per day (null for a day whose window holds no conversation the value counts), and every change the value minus its value 30 days before the as-of day (null without one). A share or win rate nothing in scope measured is { kind: absent, reason }, never 0.","tags":["discovery"],"x-cli-name":"discovery-topic-reports-get-v4","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"brandPerspective","in":"query","required":false,"description":"Read the results as this brand (one of the campaign's brands). Omit for your own.","schema":{"description":"Read the results as this brand (one of the campaign's brands). Omit for your own.","anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]}},{"name":"segments","in":"query","required":false,"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.","schema":{"maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."},"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryTopicReportsGetV4Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/engine-reports-v4/{id}":{"get":{"operationId":"discovery.engine-reports.get.v4","summary":"Get engine reports (v4)","description":"Read a campaign's AI engine report: brand share, win rate, best topic, and win and loss drivers for each AI assistant measured, over the campaign's results window (`scope.window`): every value as of the window's as-of day, averaged over the conversations dated in the 30 days ending it, every trend one point per day (null for a day whose window holds no conversation the value counts), and every change the value minus its value 30 days before the as-of day (null without one).","tags":["discovery"],"x-cli-name":"discovery-engine-reports-get-v4","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"brandPerspective","in":"query","required":false,"description":"Read the results as this brand (one of the campaign's brands). Omit for your own.","schema":{"description":"Read the results as this brand (one of the campaign's brands). Omit for your own.","anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]}},{"name":"segments","in":"query","required":false,"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.","schema":{"maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."},"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryEngineReportsGetV4Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/competitor-reports-v4/{id}":{"get":{"operationId":"discovery.competitor-reports.get.v4","summary":"Get competitor reports (v4)","description":"Deprecated: use discovery.competitor-reports.get.v5 (discovery_competitor_reports_get_v5), which names no faviconLightUrl or faviconDarkUrl: a favicon is one image for both themes, faviconUrl. This version answers the same and names both, never sent. Read a campaign's competitor report: each brand the conversations named, its share and win rate against the brand, its head-to-head record, and why the brand wins and loses against it, over the campaign's results window (`scope.window`): every value as of the window's as-of day, averaged over the conversations dated in the 30 days ending it, every trend one point per day (null for a day whose window holds no conversation the value counts), and every change the value minus its value 30 days before the as-of day (null without one).","deprecated":true,"tags":["discovery"],"x-cli-name":"discovery-competitor-reports-get-v4","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"brandPerspective","in":"query","required":false,"description":"Read the results as this brand (one of the campaign's brands). Omit for your own.","schema":{"description":"Read the results as this brand (one of the campaign's brands). Omit for your own.","anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]}},{"name":"segments","in":"query","required":false,"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.","schema":{"maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."},"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryCompetitorReportsGetV4Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/competitor-reports-v5/{id}":{"get":{"operationId":"discovery.competitor-reports.get.v5","summary":"Get competitor reports (v5)","description":"Read a campaign's competitor report: each brand the conversations named, its share and win rate against the brand, its head-to-head record, and why the brand wins and loses against it, over the campaign's results window (`scope.window`): every value as of the window's as-of day, averaged over the conversations dated in the 30 days ending it, every trend one point per day (null for a day whose window holds no conversation the value counts), and every change the value minus its value 30 days before the as-of day (null without one).","tags":["discovery"],"x-cli-name":"discovery-competitor-reports-get-v5","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"brandPerspective","in":"query","required":false,"description":"Read the results as this brand (one of the campaign's brands). Omit for your own.","schema":{"description":"Read the results as this brand (one of the campaign's brands). Omit for your own.","anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]}},{"name":"segments","in":"query","required":false,"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.","schema":{"maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."},"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryCompetitorReportsGetV5Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/sentiment-reports-v4/{id}":{"get":{"operationId":"discovery.sentiment-reports.get.v4","summary":"Get sentiment reports (v4)","description":"Read a campaign's sentiment report: positive and negative sentiment themes about the brand and its competitors, with mention share and net sentiment, over the campaign's results window (`scope.window`): every value as of the window's as-of day, averaged over the conversations dated in the 30 days ending it, every trend one point per day (null for a day whose window holds no conversation the value counts), and every change the value minus its value 30 days before the as-of day (null without one). Each polarity lists its 25 most mentioned phrases, and positivePhraseTotalCount and negativePhraseTotalCount say how many there are.","tags":["discovery"],"x-cli-name":"discovery-sentiment-reports-get-v4","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"brandPerspective","in":"query","required":false,"description":"Read the results as this brand (one of the campaign's brands). Omit for your own.","schema":{"description":"Read the results as this brand (one of the campaign's brands). Omit for your own.","anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]}},{"name":"segments","in":"query","required":false,"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.","schema":{"maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."},"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoverySentimentReportsGetV4Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/source-reports/{id}":{"get":{"operationId":"discovery.source-reports.get.v1","summary":"Get source reports","description":"Deprecated: use discovery.source-reports.get.v2 (discovery_source_reports_get_v2), which answers the results window its values read in `scope.window`, each trend as one point per day (null for a day whose window holds none of its conversations), and a change it cannot state as null; this version reads the same values, names in `scope.dispatchId` the newest run that measured a conversation of the window's last 30 days, labels each trend's days with a value (\"Oct 9\") and leaves the others out, and reads a change it cannot state as 0. Read the sources AI assistants cited and were influenced by in a campaign's conversations, by source type and domain.","deprecated":true,"tags":["discovery"],"x-cli-name":"discovery-source-reports-get","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"segments","in":"query","required":false,"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.","schema":{"maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."},"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoverySourceReportsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/source-reports-v2/{id}":{"get":{"operationId":"discovery.source-reports.get.v2","summary":"Get source reports (v2)","description":"Deprecated: use discovery.source-reports.get.v3 (discovery_source_reports_get_v3), which names no faviconLightUrl or faviconDarkUrl: a favicon is one image for both themes, faviconUrl. This version answers the same and names both, never sent. Read the sources AI assistants cited and were influenced by in a campaign's conversations, by source type and domain, over the campaign's results window (`scope.window`): every value as of the window's as-of day, averaged over the conversations dated in the 30 days ending it, every trend one point per day (null for a day whose window holds no conversation the value counts), and every change the value minus its value 30 days before the as-of day (null without one).","deprecated":true,"tags":["discovery"],"x-cli-name":"discovery-source-reports-get-v2","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"segments","in":"query","required":false,"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.","schema":{"maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."},"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoverySourceReportsGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/source-reports-v3/{id}":{"get":{"operationId":"discovery.source-reports.get.v3","summary":"Get source reports (v3)","description":"Read the sources AI assistants cited and were influenced by in a campaign's conversations, by source type and domain, over the campaign's results window (`scope.window`): every value as of the window's as-of day, averaged over the conversations dated in the 30 days ending it, every trend one point per day (null for a day whose window holds no conversation the value counts), and every change the value minus its value 30 days before the as-of day (null without one).","tags":["discovery"],"x-cli-name":"discovery-source-reports-get-v3","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"segments","in":"query","required":false,"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.","schema":{"maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."},"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoverySourceReportsGetV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/journey-maps-v3/{id}":{"get":{"operationId":"discovery.journey-maps.get.v3","summary":"Get journey maps (v3)","description":"Read a campaign's customer journey map: how conversations move from question to recommendation, which brands appear at each stage, and outcomes, over the conversations dated in the 30 days ending its results window's as-of day (`scope.window`). Brands are measured by wins, by share, and, for the campaign's own brand, by `market`: each product's AI-influenced market a year (serviceable market × AI influence, as Business revenue tracking states it) split evenly across the window's conversations on it and carried to the brand that won each one, so a brand's value is its revenue influenced, the share of the market it won in AI answers (for the campaign's own brand, discovery_overview_reports_get_v5's revenue influenced), and what no brand won is the remainder.","tags":["discovery"],"x-cli-name":"discovery-journey-maps-get-v3","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"segments","in":"query","required":false,"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.","schema":{"maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."},"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryJourneyMapsGetV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/brand-maps/{id}":{"get":{"operationId":"discovery.brand-maps.get.v1","summary":"Get brand maps","description":"Deprecated: use discovery.brand-maps.get.v2 (discovery_brand_maps_get_v2), which answers the results window the map reads in `scope.window` and carries no arc verdict; this version draws the same map, names in `scope.dispatchId` the newest run that measured a conversation of the window's last 30 days, and reads every arc's `confident` as false. Read a campaign's brand map: the brands ranked by head-to-head strength, their pairwise records, and the default ring. Brand icons are read with discovery.brand-icons.get.","deprecated":true,"tags":["discovery"],"x-cli-name":"discovery-brand-maps-get","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"segments","in":"query","required":false,"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.","schema":{"maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."},"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryBrandMapsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/brand-maps-v2/{id}":{"get":{"operationId":"discovery.brand-maps.get.v2","summary":"Get brand maps (v2)","description":"Read a campaign's brand map over the conversations dated in the 30 days ending its results window's as-of day (`scope.window`): the brands ranked by head-to-head strength, their pairwise records, and the default ring. Read a pair, a breakdown or a cohort with discovery_brand_matchups_get_v2, discovery_brand_matchup_breakdowns_get_v2 and discovery_brand_cohorts_get_v2 over the same window. Brand icons are read with discovery_brand_icons_get_v2.","tags":["discovery"],"x-cli-name":"discovery-brand-maps-get-v2","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"segments","in":"query","required":false,"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.","schema":{"maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."},"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryBrandMapsGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/source-maps/{id}":{"get":{"operationId":"discovery.source-maps.get.v1","summary":"Get source maps","description":"Deprecated: use discovery.source-maps.get.v2 (discovery_source_maps_get_v2), which answers the results window the map reads in `scope.window` and carries no run block; this version draws the same map, and its `scope.dispatchId` and `map.scope.dispatchId` name the newest run that measured a conversation of the window's last 30 days. Read a campaign's source influence map: which source types and domains shape AI assistants' recommendations of each brand.","deprecated":true,"tags":["discovery"],"x-cli-name":"discovery-source-maps-get","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"segments","in":"query","required":false,"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.","schema":{"maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."},"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoverySourceMapsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/source-maps-v2/{id}":{"get":{"operationId":"discovery.source-maps.get.v2","summary":"Get source maps (v2)","description":"Deprecated: use discovery.source-maps.get.v3 (discovery_source_maps_get_v3), which answers no faviconLightUrl or faviconDarkUrl: a favicon is one image for both themes, faviconUrl. This version answers the same with both, always null. Read a campaign's source influence map: which source types and domains shape AI assistants' recommendations of each brand, over the conversations dated in the 30 days ending its results window's as-of day (`scope.window`).","deprecated":true,"tags":["discovery"],"x-cli-name":"discovery-source-maps-get-v2","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"segments","in":"query","required":false,"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.","schema":{"maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."},"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoverySourceMapsGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/source-maps-v3/{id}":{"get":{"operationId":"discovery.source-maps.get.v3","summary":"Get source maps (v3)","description":"Read a campaign's source influence map: which source types and domains shape AI assistants' recommendations of each brand, over the conversations dated in the 30 days ending its results window's as-of day (`scope.window`).","tags":["discovery"],"x-cli-name":"discovery-source-maps-get-v3","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"segments","in":"query","required":false,"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.","schema":{"maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."},"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoverySourceMapsGetV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/market-maps/{id}":{"get":{"operationId":"discovery.market-maps.get.v1","summary":"Get market maps","description":"Deprecated: use discovery.market-maps.get.v2 (discovery_market_maps_get_v2), which answers the results window the map reads in `scope.window`; this version draws the same map and names in `scope.dispatchId` the newest run that measured a conversation of the window's last 30 days. Read a campaign's market map: the market's layers and the brands and entities seated in each, as the run's relationship analysis classified them.","deprecated":true,"tags":["discovery"],"x-cli-name":"discovery-market-maps-get","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryMarketMapsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/market-maps-v2/{id}":{"get":{"operationId":"discovery.market-maps.get.v2","summary":"Get market maps (v2)","description":"Read a campaign's market map: the market's layers, as the campaign's first run mapped them, and the brands seated in each by the entity types the conversations dated in the 30 days ending its results window's as-of day (`scope.window`) gave them.","tags":["discovery"],"x-cli-name":"discovery-market-maps-get-v2","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryMarketMapsGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/store-maps-v4/{id}":{"get":{"operationId":"discovery.store-maps.get.v4","summary":"Get store maps (v4)","description":"Read a physical-location campaign's store map: each store's location, brand share, win rate, sentiment, and revenue influence over the conversations dated in the 30 days ending its results window's as-of day (`scope.window`).","tags":["discovery"],"x-cli-name":"discovery-store-maps-get-v4","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"brandPerspective","in":"query","required":false,"description":"Read the results as this brand (one of the campaign's brands). Omit for your own.","schema":{"description":"Read the results as this brand (one of the campaign's brands). Omit for your own.","anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]}},{"name":"segments","in":"query","required":false,"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.","schema":{"maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."},"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryStoreMapsGetV4Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/store-map-changes/{id}":{"get":{"operationId":"discovery.store-map-changes.get.v1","summary":"Get store map changes","description":"Deprecated: use discovery.store-map-changes.get.v2 (discovery_store_map_changes_get_v2), which answers the results window it reads in `scope.window`; this version answers the same changes (since 30 days before the as-of day, where it named the previous run) and names in `scope.dispatchId` the newest run that measured a conversation of the window's last 30 days. Read how each store of a physical-location campaign moved: brand share and win rate in points and revenue influence in dollars.","deprecated":true,"tags":["discovery"],"x-cli-name":"discovery-store-map-changes-get","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"brandPerspective","in":"query","required":false,"description":"Read the results as this brand (one of the campaign's brands). Omit for your own.","schema":{"description":"Read the results as this brand (one of the campaign's brands). Omit for your own.","anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]}},{"name":"segments","in":"query","required":false,"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.","schema":{"maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."},"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryStoreMapChangesGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/store-map-changes-v2/{id}":{"get":{"operationId":"discovery.store-map-changes.get.v2","summary":"Get store map changes (v2)","description":"Read how each store of a physical-location campaign moved since 30 days before its results window's as-of day (`scope.window`): its brand share and win rate in points and revenue influence in dollars, each the as-of value minus the value of the window that ends 30 days earlier (null when either window holds no reading).","tags":["discovery"],"x-cli-name":"discovery-store-map-changes-get-v2","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"brandPerspective","in":"query","required":false,"description":"Read the results as this brand (one of the campaign's brands). Omit for your own.","schema":{"description":"Read the results as this brand (one of the campaign's brands). Omit for your own.","anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]}},{"name":"segments","in":"query","required":false,"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.","schema":{"maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."},"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryStoreMapChangesGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/brand-icons/{id}":{"get":{"operationId":"discovery.brand-icons.get.v1","summary":"Get brand icons","description":"Deprecated: use discovery.brand-icons.get.v2 (discovery_brand_icons_get_v2), which answers no faviconLightUrl or faviconDarkUrl: a favicon is one image for both themes, faviconUrl. This version answers the same with both, always null. Read favicon identity for named brands of a campaign, keyed by normalized brand name; a brand without a favicon carries its initials.","deprecated":true,"tags":["discovery"],"x-cli-name":"discovery-brand-icons-get","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"names","in":"query","required":true,"description":"Brand names as a map answers them in `brandNames`.","schema":{"minItems":1,"maxItems":1000,"type":"array","items":{"type":"string","minLength":1,"maxLength":200},"description":"Brand names as a map answers them in `brandNames`."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryBrandIconsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/brand-icons-v2/{id}":{"get":{"operationId":"discovery.brand-icons.get.v2","summary":"Get brand icons (v2)","description":"Read favicon identity for named brands of a campaign, keyed by normalized brand name; a brand without a favicon carries its initials.","tags":["discovery"],"x-cli-name":"discovery-brand-icons-get-v2","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"names","in":"query","required":true,"description":"Brand names as a map answers them in `brandNames`.","schema":{"minItems":1,"maxItems":1000,"type":"array","items":{"type":"string","minLength":1,"maxLength":200},"description":"Brand names as a map answers them in `brandNames`."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryBrandIconsGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/report-rows":{"get":{"operationId":"discovery.report-rows.list.v1","summary":"List report rows","description":"Deprecated: use reports.report-tables.get.v1 (reports_report_tables_get). Lists the rows discovery.report-rows.list.v2 lists and names in `scope.dispatchId` the newest run that measured a conversation of the window's last 30 days. Page through a campaign's report table for one row dimension (conversations, customers, or win reasons, loss reasons, decision factors, sentiment themes) with chosen columns, filters, sort, and search, each read through the report dataset that replaced it.","deprecated":true,"tags":["discovery"],"x-cli-name":"discovery-report-rows-list","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"id","in":"query","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"segments","in":"query","required":false,"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.","schema":{"maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."},"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch."}},{"name":"dimension","in":"query","required":true,"description":"What one row is: a conversation, a customer, or a win reason, loss reason, decision factor, or sentiment theme with the conversations citing it.","schema":{"type":"string","enum":["conversations","customers","win-reasons","loss-reasons","decision-factors","positive-sentiment","negative-sentiment"],"description":"What one row is: a conversation, a customer, or a win reason, loss reason, decision factor, or sentiment theme with the conversations citing it."}},{"name":"columns","in":"query","required":true,"description":"The dimension's fields each row carries, in order. `conversations`: customerName, engine, date, winner, sentiment, decisionFactor, topics. `customers`: name, conversations, jobTitle, employer, groups, winRate. Every label dimension: name, conversations, share.","schema":{"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":100},"description":"The dimension's fields each row carries, in order. `conversations`: customerName, engine, date, winner, sentiment, decisionFactor, topics. `customers`: name, conversations, jobTitle, employer, groups, winRate. Every label dimension: name, conversations, share."}},{"name":"filters","in":"query","required":false,"description":"Every filter must hold (AND).","schema":{"description":"Every filter must hold (AND).","maxItems":100,"type":"array","items":{"type":"string","maxLength":1140,"description":"`columnId:operator:value`; operator is contains, equals, gt, lt (numeric fields), is-empty, or is-not-empty (value ignored). Text matches ignore case."}}},{"name":"sortColumn","in":"query","required":false,"description":"Omit to keep the dimension's own order.","schema":{"description":"Omit to keep the dimension's own order.","type":"string","minLength":1,"maxLength":100}},{"name":"sortDirection","in":"query","required":false,"description":"With sortColumn; default asc.","schema":{"description":"With sortColumn; default asc.","type":"string","enum":["asc","desc"]}},{"name":"search","in":"query","required":false,"description":"Free text matched against the selected columns as displayed.","schema":{"description":"Free text matched against the selected columns as displayed.","type":"string","maxLength":240}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryReportRowsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/report-rows-v2":{"get":{"operationId":"discovery.report-rows.list.v2","summary":"List report rows (v2)","description":"Deprecated: use reports.report-tables.get.v1 (reports_report_tables_get). Page through a campaign's report table for one row dimension (conversations, customers, or win reasons, loss reasons, decision factors, sentiment themes) with chosen columns, filters, sort, and search, over the campaign's conversations dated in the 30 days ending the results window's as-of day (`scope.window`). Each table is read through the report dataset that replaced it: conversations as discovery.conversations lists them, customers by customer from discovery.brand-performance, reasons from discovery.reasons (a win reason of a conversation the brand won, the brand's gap to the winner in one it did not), sentiment themes from discovery.sentiment-themes (the campaign brand's). What no dataset names is left out: decision factors list no row, and a customer's job title, employer and groups and a conversation's decision factor are null.","deprecated":true,"tags":["discovery"],"x-cli-name":"discovery-report-rows-list-v2","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"id","in":"query","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"segments","in":"query","required":false,"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.","schema":{"maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."},"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch."}},{"name":"dimension","in":"query","required":true,"description":"What one row is: a conversation, a customer, or a win reason, loss reason, decision factor, or sentiment theme with the conversations citing it.","schema":{"type":"string","enum":["conversations","customers","win-reasons","loss-reasons","decision-factors","positive-sentiment","negative-sentiment"],"description":"What one row is: a conversation, a customer, or a win reason, loss reason, decision factor, or sentiment theme with the conversations citing it."}},{"name":"columns","in":"query","required":true,"description":"The dimension's fields each row carries, in order. `conversations`: customerName, engine, date, winner, sentiment, decisionFactor, topics. `customers`: name, conversations, jobTitle, employer, groups, winRate. Every label dimension: name, conversations, share.","schema":{"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":100},"description":"The dimension's fields each row carries, in order. `conversations`: customerName, engine, date, winner, sentiment, decisionFactor, topics. `customers`: name, conversations, jobTitle, employer, groups, winRate. Every label dimension: name, conversations, share."}},{"name":"filters","in":"query","required":false,"description":"Every filter must hold (AND).","schema":{"description":"Every filter must hold (AND).","maxItems":100,"type":"array","items":{"type":"string","maxLength":1140,"description":"`columnId:operator:value`; operator is contains, equals, gt, lt (numeric fields), is-empty, or is-not-empty (value ignored). Text matches ignore case."}}},{"name":"sortColumn","in":"query","required":false,"description":"Omit to keep the dimension's own order.","schema":{"description":"Omit to keep the dimension's own order.","type":"string","minLength":1,"maxLength":100}},{"name":"sortDirection","in":"query","required":false,"description":"With sortColumn; default asc.","schema":{"description":"With sortColumn; default asc.","type":"string","enum":["asc","desc"]}},{"name":"search","in":"query","required":false,"description":"Free text matched against the selected columns as displayed.","schema":{"description":"Free text matched against the selected columns as displayed.","type":"string","maxLength":240}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryReportRowsListV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/conversation-previews":{"get":{"operationId":"discovery.conversation-previews.list.v1","summary":"List conversation previews","description":"Deprecated: use discovery.conversation-previews.list.v2 (discovery_conversation_previews_list_v2), which answers the results window its previews read in `scope.window`; this version lists the same previews and names in `scope.dispatchId` the newest run that measured a conversation of the window's last 30 days. List the newest conversations of a campaign's results window as previews, at most 12, optionally narrowed to segments: each customer's name and job title or age, the assistant, when it happened, the brands it named and their role, and its first turns. Of those, the ones held in the campaign's language come first, newest first within each group: the campaign's language is its profile's, else English, and a customer who declares no language speaks it. A campaign without results answers its state and no previews. Page through and search every conversation with discovery.conversations.list.","deprecated":true,"tags":["discovery"],"x-cli-name":"discovery-conversation-previews-list","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of previews to return (1–12)","schema":{"default":12,"description":"Number of previews to return (1–12)","type":"integer","minimum":1,"maximum":12}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"campaignId","in":"query","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"segments","in":"query","required":false,"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.","schema":{"maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."},"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryConversationPreviewsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/conversation-previews-v2":{"get":{"operationId":"discovery.conversation-previews.list.v2","summary":"List conversation previews (v2)","description":"Deprecated: use discovery.conversation-previews.list.v3 (discovery_conversation_previews_list_v3), which names no faviconLightUrl or faviconDarkUrl: a favicon is one image for both themes, faviconUrl. This version answers the same and names both, never sent. List the newest conversations of a campaign's results window (dated in the 30 days ending its as-of day, `scope.window`) as previews, at most 12, optionally narrowed to segments: each customer's name and job title or age, the assistant, when it happened, the brands it named and their role, and its first turns. Of those, the ones held in the campaign's language come first, newest first within each group: the campaign's language is its profile's, else English, and a customer who declares no language speaks it. A campaign without results answers its state and no previews. Page through and search every conversation with discovery_conversations_list_v2.","deprecated":true,"tags":["discovery"],"x-cli-name":"discovery-conversation-previews-list-v2","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of previews to return (1–12)","schema":{"default":12,"description":"Number of previews to return (1–12)","type":"integer","minimum":1,"maximum":12}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"campaignId","in":"query","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"segments","in":"query","required":false,"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.","schema":{"maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."},"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryConversationPreviewsListV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/conversation-previews-v3":{"get":{"operationId":"discovery.conversation-previews.list.v3","summary":"List conversation previews (v3)","description":"List the newest conversations of a campaign's results window (dated in the 30 days ending its as-of day, `scope.window`) as previews, at most 12, optionally narrowed to segments: each customer's name and job title or age, the assistant, when it happened, the brands it named and their role, and its first turns. Of those, the ones held in the campaign's language come first, newest first within each group: the campaign's language is its profile's, else English, and a customer who declares no language speaks it. A campaign without results answers its state and no previews. Page through and search every conversation with discovery_conversations_list_v2.","tags":["discovery"],"x-cli-name":"discovery-conversation-previews-list-v3","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of previews to return (1–12)","schema":{"default":12,"description":"Number of previews to return (1–12)","type":"integer","minimum":1,"maximum":12}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"campaignId","in":"query","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"segments","in":"query","required":false,"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.","schema":{"maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."},"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryConversationPreviewsListV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/conversations":{"get":{"operationId":"discovery.conversations.list.v1","summary":"List conversations","description":"Deprecated: use discovery.conversations.list.v2 (discovery_conversations_list_v2), which answers the results window its rows read in `scope.window`; this version lists the same conversations and names in `scope.dispatchId` the newest run that measured a conversation of the window's last 30 days. Page through every conversation of a campaign's results window, newest or oldest first, optionally narrowed to segments, one assistant, and the campaign brand's outcome (won; mentioned while another brand or none won; absent), and searched, ignoring case, by the customer's name and the transcript's text (the customer's prompts and the assistant's answers). Each row names the customer, the assistant, when it started, how many turns it shows, the outcome, the winner and the brands it named, its first prompt, where a search hit, and how many sources it cited. Read one transcript in full with business.customer-conversations.get (the row's conversationId as `id`, and its customerId). A campaign without results answers its state and no rows.","deprecated":true,"tags":["discovery"],"x-cli-name":"discovery-conversations-list","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of conversations to return (1–50)","schema":{"default":25,"description":"Number of conversations to return (1–50)","type":"integer","minimum":1,"maximum":50}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"id","in":"query","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"segments","in":"query","required":false,"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.","schema":{"maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."},"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch."}},{"name":"search","in":"query","required":false,"description":"Text matched, ignoring case, against the customer's name and the transcript (prompts and answers).","schema":{"description":"Text matched, ignoring case, against the customer's name and the transcript (prompts and answers).","type":"string","maxLength":200}},{"name":"engine","in":"query","required":false,"description":"Only this assistant's conversations.","schema":{"description":"Only this assistant's conversations.","type":"string","enum":["chatgpt","gemini","claude","grok"]}},{"name":"outcome","in":"query","required":false,"description":"Only conversations with this outcome for the campaign's brand.","schema":{"description":"Only conversations with this outcome for the campaign's brand.","type":"string","enum":["won","mentioned","absent"]}},{"name":"conversationId","in":"query","required":false,"description":"Only this conversation: its row when the window and segments hold it, else none, so a link to one conversation reads its row once.","schema":{"description":"Only this conversation: its row when the window and segments hold it, else none, so a link to one conversation reads its row once.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"sort","in":"query","required":false,"description":"By when each conversation started; default newest first.","schema":{"default":"newest","description":"By when each conversation started; default newest first.","type":"string","enum":["newest","oldest"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryConversationsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/conversations-v2":{"get":{"operationId":"discovery.conversations.list.v2","summary":"List conversations (v2)","description":"Page through every conversation of a campaign's results window (dated in the 30 days ending its as-of day, `scope.window`: the conversations its values count), newest or oldest first, optionally narrowed to segments, one assistant, the campaign brand's outcome (won; mentioned while another brand or none won; absent), and its matchup with one rival (`rival`: the conversations its win and loss reasons against that brand are counted from), and searched, ignoring case, by the customer's name and the transcript's text (the customer's prompts and the assistant's answers). Each row names the customer, the assistant, when it started, how many turns it shows, the outcome, the winner and the brands it named, its first prompt, where a search hit, and how many sources it cited. Read one transcript in full with business_customer_conversations_get_v2 (the row's conversationId as `id`, and its customerId). A campaign without results answers its state and no rows.","tags":["discovery"],"x-cli-name":"discovery-conversations-list-v2","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of conversations to return (1–50)","schema":{"default":25,"description":"Number of conversations to return (1–50)","type":"integer","minimum":1,"maximum":50}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"id","in":"query","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"segments","in":"query","required":false,"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.","schema":{"maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."},"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch."}},{"name":"search","in":"query","required":false,"description":"Text matched, ignoring case, against the customer's name and the transcript (prompts and answers).","schema":{"description":"Text matched, ignoring case, against the customer's name and the transcript (prompts and answers).","type":"string","maxLength":200}},{"name":"engine","in":"query","required":false,"description":"Only this assistant's conversations.","schema":{"description":"Only this assistant's conversations.","type":"string","enum":["chatgpt","gemini","claude","grok"]}},{"name":"outcome","in":"query","required":false,"description":"Only conversations with this outcome for the campaign's brand.","schema":{"description":"Only conversations with this outcome for the campaign's brand.","type":"string","enum":["won","mentioned","absent"]}},{"name":"conversationId","in":"query","required":false,"description":"Only this conversation: its row when the window and segments hold it, else none, so a link to one conversation reads its row once.","schema":{"description":"Only this conversation: its row when the window and segments hold it, else none, so a link to one conversation reads its row once.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"sort","in":"query","required":false,"description":"By when each conversation started; default newest first.","schema":{"default":"newest","description":"By when each conversation started; default newest first.","type":"string","enum":["newest","oldest"]}},{"name":"rival","in":"query","required":false,"description":"Only the campaign brand's matchup with this brand: conversations that name both, where one of the two is the brand the conversation recommended, the conversations discovery.competitor-reasons.get counts its win and loss reasons against that brand from. Name it as those reasons do (`data.option.id`). With `outcome`, `won` keeps the campaign brand's wins and `mentioned` its losses to that brand.","schema":{"description":"Only the campaign brand's matchup with this brand: conversations that name both, where one of the two is the brand the conversation recommended, the conversations discovery.competitor-reasons.get counts its win and loss reasons against that brand from. Name it as those reasons do (`data.option.id`). With `outcome`, `won` keeps the campaign brand's wins and `mentioned` its losses to that brand.","type":"string","minLength":1,"maxLength":300}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryConversationsListV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/conversations/export-v3":{"get":{"operationId":"discovery.conversations.export.v3","summary":"Export conversations (v3)","description":"Export a campaign's conversations of a date range as CSV (one row per conversation, no transcripts), JSONL, or Markdown (both with transcripts), optionally filtered: each conversation measured for the campaign's results, dated by the UTC day it ended. Answers the campaign's results window over the range (`scope`) and the file's name, type and size with a short-lived `url` to GET it (fetch it before `expiresAt`; call again for a fresh export). A campaign without results exports an empty file. Every export is audited.","tags":["discovery"],"x-cli-name":"discovery-conversations-export-v3","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"campaignId","in":"query","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"format","in":"query","required":false,"description":"`csv`: one row per conversation, no transcripts. `jsonl`: one JSON conversation per line, with its transcript. `markdown`: readable transcripts.","schema":{"default":"csv","description":"`csv`: one row per conversation, no transcripts. `jsonl`: one JSON conversation per line, with its transcript. `markdown`: readable transcripts.","type":"string","enum":["csv","jsonl","markdown"]}},{"name":"engine","in":"query","required":false,"description":"Only assistants whose name contains this text (text filters ignore case).","schema":{"description":"Only assistants whose name contains this text (text filters ignore case).","type":"string","minLength":1,"maxLength":500}},{"name":"sentiment","in":"query","required":false,"description":"Only conversations of this overall sentiment.","schema":{"description":"Only conversations of this overall sentiment.","type":"string","enum":["positive","neutral","mixed","negative"]}},{"name":"topic","in":"query","required":false,"description":"Only conversations with a topic containing this text.","schema":{"description":"Only conversations with a topic containing this text.","type":"string","minLength":1,"maxLength":500}},{"name":"label","in":"query","required":false,"description":"Only conversations whose win reason, loss reason, or decision factor contains this text.","schema":{"description":"Only conversations whose win reason, loss reason, or decision factor contains this text.","type":"string","minLength":1,"maxLength":500}},{"name":"source","in":"query","required":false,"description":"Only conversations with a source whose URL or site name contains this text.","schema":{"description":"Only conversations with a source whose URL or site name contains this text.","type":"string","minLength":1,"maxLength":500}},{"name":"outcome","in":"query","required":false,"description":"Only conversations your brand won, lost, was mentioned in, or was absent from.","schema":{"description":"Only conversations your brand won, lost, was mentioned in, or was absent from.","type":"string","enum":["won","lost","mentioned","absent"]}},{"name":"labels","in":"query","required":false,"description":"Only customers on a list (Labels) whose name contains this text.","schema":{"description":"Only customers on a list (Labels) whose name contains this text.","type":"string","minLength":1,"maxLength":500}},{"name":"product","in":"query","required":false,"description":"Only conversations about a product (revenue line) whose name contains this text.","schema":{"description":"Only conversations about a product (revenue line) whose name contains this text.","type":"string","minLength":1,"maxLength":500}},{"name":"audience","in":"query","required":false,"description":"Only customers of an audience whose name contains this text.","schema":{"description":"Only customers of an audience whose name contains this text.","type":"string","minLength":1,"maxLength":500}},{"name":"channel","in":"query","required":false,"description":"Only customers of a channel whose name contains this text.","schema":{"description":"Only customers of a channel whose name contains this text.","type":"string","minLength":1,"maxLength":500}},{"name":"market","in":"query","required":false,"description":"Only customers of a market whose name contains this text.","schema":{"description":"Only customers of a market whose name contains this text.","type":"string","minLength":1,"maxLength":500}},{"name":"dateRange","in":"query","required":false,"description":"The days whose conversations the file holds: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default range.","schema":{"description":"The days whose conversations the file holds: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default range.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryConversationsExportV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/report-tables/export":{"get":{"operationId":"discovery.report-tables.export.v1","summary":"Export report tables","description":"Deprecated: use reports.report-tables.export.v1 (reports_report_tables_export). Exports the file discovery.report-tables.export.v2 exports, without the results window it read. Export every row of a campaign's report table for one dimension, with chosen columns, filters, sort, and search, as CSV (cells as the dashboard displays them). Answers the file's name, type and size with a short-lived `url` to GET it (fetch it before `expiresAt`; call again for a fresh export). Every export is audited.","deprecated":true,"tags":["discovery"],"x-cli-name":"discovery-report-tables-export","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"query","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"segments","in":"query","required":false,"description":"Narrows the table to these `axis:id` segments, ANDed; entries the campaign does not have are ignored, as the dashboard ignores them.","schema":{"description":"Narrows the table to these `axis:id` segments, ANDed; entries the campaign does not have are ignored, as the dashboard ignores them.","maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."}}},{"name":"dimension","in":"query","required":true,"description":"What one row is: a product (`revenue`: one of the business's revenue lines), audience, channel, location, topic, competitor, engine, or source (the campaign's reports), or a conversation, customer, win reason, loss reason, decision factor, or sentiment theme.","schema":{"type":"string","enum":["revenue","audiences","channels","locations","topics","competitors","engines","sources","conversations","customers","win-reasons","loss-reasons","decision-factors","positive-sentiment","negative-sentiment"],"description":"What one row is: a product (`revenue`: one of the business's revenue lines), audience, channel, location, topic, competitor, engine, or source (the campaign's reports), or a conversation, customer, win reason, loss reason, decision factor, or sentiment theme."}},{"name":"rows","in":"query","required":false,"description":"Default true. False exports the header line alone, as the report builder shows a table whose rows are unset.","schema":{"description":"Default true. False exports the header line alone, as the report builder shows a table whose rows are unset.","type":"boolean"}},{"name":"columns","in":"query","required":false,"description":"The dimension's columns, in order; the `name` column always leads when rows are exported. Omit (or send none) for the dimension's default columns.","schema":{"description":"The dimension's columns, in order; the `name` column always leads when rows are exported. Omit (or send none) for the dimension's default columns.","maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":100}}},{"name":"filters","in":"query","required":false,"description":"Every filter must hold (AND); numeric columns take gt, lt, equals with a number.","schema":{"description":"Every filter must hold (AND); numeric columns take gt, lt, equals with a number.","maxItems":100,"type":"array","items":{"type":"string","maxLength":1140,"description":"`columnId:operator:value`; operator is contains, equals, gt, lt (numeric fields), is-empty, or is-not-empty (value ignored). Text matches ignore case."}}},{"name":"sortColumn","in":"query","required":false,"description":"The column to sort by; `none` keeps the dimension's own order. Omit for the dimension's default sort.","schema":{"description":"The column to sort by; `none` keeps the dimension's own order. Omit for the dimension's default sort.","type":"string","minLength":1,"maxLength":100}},{"name":"sortDirection","in":"query","required":false,"description":"With sortColumn; default asc.","schema":{"description":"With sortColumn; default asc.","type":"string","enum":["asc","desc"]}},{"name":"search","in":"query","required":false,"description":"Free text matched against the selected columns as displayed.","schema":{"description":"Free text matched against the selected columns as displayed.","type":"string","maxLength":240}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryReportTablesExportResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/report-tables/export-v2":{"get":{"operationId":"discovery.report-tables.export.v2","summary":"Export report tables (v2)","description":"Deprecated: use reports.report-tables.export.v1 (reports_report_tables_export). Export every row of a campaign's report table for one dimension, with chosen columns, filters, sort, and search, as CSV (cells as the dashboard displays them), over the campaign's results window. Answers that window (`scope.window`) and the file's name, type and size with a short-lived `url` to GET it (fetch it before `expiresAt`; call again for a fresh export). Each table is read through the report dataset that replaced it (segments from discovery.brand-performance, sources from discovery.sources, and the row tables as discovery.report-rows.list.v2 reads them); what no dataset names is left out: locations and decision factors export no row, and a source's type is empty. The competitors table lists the campaign's own brand among the brands, as the Competitors leaderboard does. Every export is audited.","deprecated":true,"tags":["discovery"],"x-cli-name":"discovery-report-tables-export-v2","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"query","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"segments","in":"query","required":false,"description":"Narrows the table to these `axis:id` segments, ANDed; entries the campaign does not have are ignored, as the dashboard ignores them.","schema":{"description":"Narrows the table to these `axis:id` segments, ANDed; entries the campaign does not have are ignored, as the dashboard ignores them.","maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."}}},{"name":"dimension","in":"query","required":true,"description":"What one row is: a product (`revenue`: one of the business's revenue lines), audience, channel, location, topic, competitor, engine, or source (the campaign's reports), or a conversation, customer, win reason, loss reason, decision factor, or sentiment theme.","schema":{"type":"string","enum":["revenue","audiences","channels","locations","topics","competitors","engines","sources","conversations","customers","win-reasons","loss-reasons","decision-factors","positive-sentiment","negative-sentiment"],"description":"What one row is: a product (`revenue`: one of the business's revenue lines), audience, channel, location, topic, competitor, engine, or source (the campaign's reports), or a conversation, customer, win reason, loss reason, decision factor, or sentiment theme."}},{"name":"rows","in":"query","required":false,"description":"Default true. False exports the header line alone, as the report builder shows a table whose rows are unset.","schema":{"description":"Default true. False exports the header line alone, as the report builder shows a table whose rows are unset.","type":"boolean"}},{"name":"columns","in":"query","required":false,"description":"The dimension's columns, in order; the `name` column always leads when rows are exported. Omit (or send none) for the dimension's default columns.","schema":{"description":"The dimension's columns, in order; the `name` column always leads when rows are exported. Omit (or send none) for the dimension's default columns.","maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":100}}},{"name":"filters","in":"query","required":false,"description":"Every filter must hold (AND); numeric columns take gt, lt, equals with a number.","schema":{"description":"Every filter must hold (AND); numeric columns take gt, lt, equals with a number.","maxItems":100,"type":"array","items":{"type":"string","maxLength":1140,"description":"`columnId:operator:value`; operator is contains, equals, gt, lt (numeric fields), is-empty, or is-not-empty (value ignored). Text matches ignore case."}}},{"name":"sortColumn","in":"query","required":false,"description":"The column to sort by; `none` keeps the dimension's own order. Omit for the dimension's default sort.","schema":{"description":"The column to sort by; `none` keeps the dimension's own order. Omit for the dimension's default sort.","type":"string","minLength":1,"maxLength":100}},{"name":"sortDirection","in":"query","required":false,"description":"With sortColumn; default asc.","schema":{"description":"With sortColumn; default asc.","type":"string","enum":["asc","desc"]}},{"name":"search","in":"query","required":false,"description":"Free text matched against the selected columns as displayed.","schema":{"description":"Free text matched against the selected columns as displayed.","type":"string","maxLength":240}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryReportTablesExportV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/store-customer-maps/{id}":{"get":{"operationId":"discovery.store-customer-maps.get.v1","summary":"Get store customer maps","description":"Deprecated: use discovery.store-customer-maps.get.v2 (discovery_store_customer_maps_get_v2), which reads the campaign's results window; this version reads the one completed run `dispatchId` names. Read where a physical-location campaign's customers live on one completed run: each mapped customer's home point, store, conversation outcome, and the brands their conversations named, the full panel's outcome by store, and how many customers the map could not place.","deprecated":true,"tags":["discovery"],"x-cli-name":"discovery-store-customer-maps-get","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dispatchId","in":"query","required":true,"description":"The completed run to read: the `scope.dispatchId` of a superseded `discovery.store-maps.get`.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The completed run to read: the `scope.dispatchId` of a superseded `discovery.store-maps.get`."}},{"name":"segments","in":"query","required":false,"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.","schema":{"maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."},"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryStoreCustomerMapsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/store-customer-maps-v2/{id}":{"get":{"operationId":"discovery.store-customer-maps.get.v2","summary":"Get store customer maps (v2)","description":"Read where a physical-location campaign's customers live, with their conversations dated in the 30 days ending its results window's as-of day (`scope.window`): each mapped customer's home point, store, conversation outcome, and the brands their conversations named, every outcome by store, and how many customers the map could not place.","tags":["discovery"],"x-cli-name":"discovery-store-customer-maps-get-v2","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"segments","in":"query","required":false,"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.","schema":{"maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."},"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryStoreCustomerMapsGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/store-customers/{id}":{"get":{"operationId":"discovery.store-customers.get.v1","summary":"Get store customers","description":"Deprecated: use discovery.store-customers.get.v2 (discovery_store_customers_get_v2), which reads the campaign's results window; this version reads the one completed run `dispatchId` names. Read one customer of a physical-location campaign as the campaign froze them (name, age, job, employer, city, home point, store) with their conversation outcome on one completed run.","deprecated":true,"tags":["discovery"],"x-cli-name":"discovery-store-customers-get","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The customer id (a `points[].customerId`).","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The customer id (a `points[].customerId`)."}},{"name":"campaignId","in":"query","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dispatchId","in":"query","required":true,"description":"The completed run to read: the `scope.dispatchId` of a superseded `discovery.store-maps.get`.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The completed run to read: the `scope.dispatchId` of a superseded `discovery.store-maps.get`."}},{"name":"segments","in":"query","required":false,"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.","schema":{"maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."},"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryStoreCustomersGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/store-customers-v2/{id}":{"get":{"operationId":"discovery.store-customers.get.v2","summary":"Get store customers (v2)","description":"Read one customer of a physical-location campaign as the campaign froze them (name, age, job, employer, city, home point, store) with the outcome of their conversations dated in the 30 days ending its results window's as-of day.","tags":["discovery"],"x-cli-name":"discovery-store-customers-get-v2","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The customer id (a `points[].customerId`).","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The customer id (a `points[].customerId`)."}},{"name":"campaignId","in":"query","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"segments","in":"query","required":false,"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.","schema":{"maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."},"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryStoreCustomersGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/campaign-setups/retry":{"post":{"operationId":"discovery.campaign-setups.retry.v1","summary":"Retry campaign setups","description":"Retry a campaign's setup, typically after it failed: start a new full measurement run of the whole panel. The run is admitted and charged like any Discovery run (it consumes plan allowance, and overage only where the organization allows it). Responds at once with the run id; read progress with platform_runs_get_v2.","tags":["discovery"],"x-cli-name":"discovery-campaign-setups-retry","x-point11-scope":"discovery:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryCampaignSetupsRetryRequest"}}}},"responses":{"202":{"description":"Accepted: the durable run started. Follow it with `GET /api/v1/platform/runs-v2/{id}`.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryCampaignSetupsRetryResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/location-reports/{id}":{"get":{"operationId":"discovery.location-reports.get.v1","summary":"Get location reports","description":"Deprecated: use discovery.location-reports.get.v2 (discovery_location_reports_get_v2), which answers the results window it reads in `scope.window`, each place's change since 30 days before the as-of day (null without one), and no precision fields; this version reads the same, names in `scope.dispatchId` the newest run that measured a conversation of the window's last 30 days, and reads a change it cannot name as 0. Read a campaign's Locations report: its customers rolled up country → region → city → postcode, with each place's brand share, win rate, win and loss reasons, and revenue influence, under an optional brand lens and segments. Pass drivers=false or revenue=false to skip those reads.","deprecated":true,"tags":["discovery"],"x-cli-name":"discovery-location-reports-get","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"brandPerspective","in":"query","required":false,"description":"Read the results as this brand (one of the campaign's brands). Omit for your own.","schema":{"description":"Read the results as this brand (one of the campaign's brands). Omit for your own.","anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]}},{"name":"segments","in":"query","required":false,"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.","schema":{"maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."},"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch."}},{"name":"drivers","in":"query","required":false,"description":"Read each place's win and loss reasons. Default true; false leaves `drivers` empty.","schema":{"description":"Read each place's win and loss reasons. Default true; false leaves `drivers` empty.","type":"boolean"}},{"name":"revenue","in":"query","required":false,"description":"Read revenue influence. Default true; it is read only under the campaign's own brand.","schema":{"description":"Read revenue influence. Default true; it is read only under the campaign's own brand.","type":"boolean"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryLocationReportsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/location-reports-v2/{id}":{"get":{"operationId":"discovery.location-reports.get.v2","summary":"Get location reports (v2)","description":"Read a campaign's Locations report over the conversations dated in the 30 days ending its results window's as-of day (`scope.window`): its customers rolled up country → region → city → postcode, with each place's brand share and win rate and their change since 30 days before the as-of day, its win and loss reasons, and revenue influence, under an optional brand lens and segments. Pass drivers=false or revenue=false to skip those reads.","tags":["discovery"],"x-cli-name":"discovery-location-reports-get-v2","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"dateRange","in":"query","required":false,"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","schema":{"description":"Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.","anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}]}},{"name":"brandPerspective","in":"query","required":false,"description":"Read the results as this brand (one of the campaign's brands). Omit for your own.","schema":{"description":"Read the results as this brand (one of the campaign's brands). Omit for your own.","anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]}},{"name":"segments","in":"query","required":false,"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.","schema":{"maxItems":1023,"type":"array","items":{"type":"string","maxLength":340,"description":"`axis:id`, e.g. `engine:chatgpt`: a pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or `store` / `customer`, with the id as `discovery.segment-options.get` lists it."},"description":"Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch."}},{"name":"drivers","in":"query","required":false,"description":"Read each place's win and loss reasons. Default true; false leaves `drivers` empty.","schema":{"description":"Read each place's win and loss reasons. Default true; false leaves `drivers` empty.","type":"boolean"}},{"name":"revenue","in":"query","required":false,"description":"Read revenue influence. Default true; it is read only under the campaign's own brand.","schema":{"description":"Read revenue influence. Default true; it is read only under the campaign's own brand.","type":"boolean"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryLocationReportsGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/website-icons/resolve":{"get":{"operationId":"discovery.website-icons.resolve.v1","summary":"Resolve website icons","description":"Deprecated: use discovery.website-icons.resolve.v2 (discovery_website_icons_resolve_v2), which answers the icon whole (its URL as faviconUrl, with the label its monogram draws, its tone and its backplates). This version answers only the URL, as iconUrl. Resolve a website's favicon as Point11's stored copy: a website Point11 never checked is checked once while the call waits (the icons its homepage declares, read from its www. host when the bare host cannot serve it, then its /favicon.ico) and stored; the answer is null when the site has none or the check has not finished, which Point11 completes shortly. A website that fails URL-safety checks is refused; checking websites is rate-limited per credential.","deprecated":true,"tags":["discovery"],"x-cli-name":"discovery-website-icons-resolve","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"url","in":"query","required":true,"description":"The website's absolute URL, e.g. `https://example.com`.","schema":{"type":"string","format":"uri","description":"The website's absolute URL, e.g. `https://example.com`."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryWebsiteIconsResolveResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/website-icons/resolve-v2":{"get":{"operationId":"discovery.website-icons.resolve.v2","summary":"Resolve website icons (v2)","description":"Resolve a website's icon as Point11's stored copy, with its tone and backplates: a website Point11 never checked is checked once while the call waits (the icons its homepage declares, read from its www. host when the bare host cannot serve it, then its /favicon.ico) and stored; when the site has none or the check has not finished (Point11 completes it shortly), faviconUrl is null and the answer carries the label its monogram draws. A website that fails URL-safety checks is refused; checking websites is rate-limited per credential.","tags":["discovery"],"x-cli-name":"discovery-website-icons-resolve-v2","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"url","in":"query","required":true,"description":"The website's absolute URL, e.g. `https://example.com`.","schema":{"type":"string","format":"uri","description":"The website's absolute URL, e.g. `https://example.com`."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryWebsiteIconsResolveV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/website-suggestions/search":{"get":{"operationId":"discovery.website-suggestions.search.v1","summary":"Search website suggestions","description":"Search the organization's own websites by what was typed: the sites of its active business profiles, its campaigns' addresses, and the target and competitor brands its Discovery campaigns resolved. A site answers when its host, ignoring a scheme and www., starts with the query or, for a query without a dot, when a word of its name does; a query naming a path answers none. Each site is its bare host, once, with the name of its profile or brand, ordered by how many of the organization's profiles, campaigns and campaign brands name it, then the shorter host, then alphabetically. Never another organization's sites.","tags":["discovery"],"x-cli-name":"discovery-website-suggestions-search","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"query","in":"query","required":true,"description":"What was typed, e.g. `winde`, `www.windermere.com` or `home depot`.","schema":{"type":"string","minLength":1,"maxLength":253,"description":"What was typed, e.g. `winde`, `www.windermere.com` or `home depot`."}},{"name":"limit","in":"query","required":false,"description":"Number of sites to return (1–10).","schema":{"default":8,"description":"Number of sites to return (1–10).","type":"integer","minimum":1,"maximum":10}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryWebsiteSuggestionsSearchResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/profile-competitor-websites/{id}":{"get":{"operationId":"discovery.profile-competitor-websites.get.v1","summary":"Get profile competitor websites","description":"List a business profile's own competitors with their websites: each competitor the profile names, in the profile's order, whose brand one of the profile's live Discovery campaigns resolved to a site under that name or an alias. Each site is the domain Discovery registered for the brand (the page an answer cited is often a help center or one article), else that page's bare host, once; a brand an operator set wins over one resolved. A competitor no campaign resolved is left out, as is the profile's own site; a profile naming no competitors answers none. Not found when the profile is not the organization's.","tags":["discovery"],"x-cli-name":"discovery-profile-competitor-websites-get","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The business profile's id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The business profile's id."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryProfileCompetitorWebsitesGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/campaigns/launch":{"post":{"operationId":"discovery.campaigns.launch.v1","summary":"Launch campaigns","description":"Deprecated: use discovery.campaigns.launch.v2 (discovery_campaigns_launch_v2), which takes no replacesCampaignId: a campaign's settings change in place with discovery.campaign-settings.update.v2, so this version refuses a replacesCampaignId (PRECONDITION_FAILED, details.reason use_campaign_settings) and otherwise launches exactly as v2, naming the same campaign for the same Idempotency-Key. Start a Discovery campaign for a website or an existing business profile (url may be null when businessProfileId is supplied), for an organization whose Analytics subscription already admits work and whose payment method is on file. Its conversations accrue against the organization's Analytics plan as they run. This never subscribes, applies an offer, or asks for a card: an organization without an active subscription or saved payment method is refused and subscribes in the Point11 dashboard first. Returns the campaign; its setup runs in the background.","deprecated":true,"tags":["discovery"],"x-cli-name":"discovery-campaigns-launch","x-point11-scope":"discovery:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryCampaignsLaunchRequest"}}}},"responses":{"202":{"description":"Accepted: the durable run started. Follow it with `GET /api/v1/platform/runs-v2/{id}`.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryCampaignsLaunchResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/campaigns/launch-v2":{"post":{"operationId":"discovery.campaigns.launch.v2","summary":"Launch campaigns (v2)","description":"Start a Discovery campaign for a website or an existing business profile (url may be null when businessProfileId is supplied), for an organization whose Analytics subscription already admits work and whose payment method is on file. Its conversations accrue against the organization's Analytics plan as they run. This never subscribes, applies an offer, or asks for a card: an organization without an active subscription or saved payment method is refused and subscribes in the Point11 dashboard first. A retry with the same Idempotency-Key answers the same campaign, through this version or v1. Change a running campaign's settings with discovery_campaign_settings_update_v2. Returns the campaign; its setup runs in the background.","tags":["discovery"],"x-cli-name":"discovery-campaigns-launch-v2","x-point11-scope":"discovery:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryCampaignsLaunchV2Request"}}}},"responses":{"202":{"description":"Accepted: the durable run started. Follow it with `GET /api/v1/platform/runs-v2/{id}`.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryCampaignsLaunchV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/campaigns/update":{"post":{"operationId":"discovery.campaigns.update.v1","summary":"Update campaigns","description":"Deprecated: use discovery.campaign-settings.update.v2 (discovery_campaign_settings_update_v2), which renames a campaign with every other setting in one Save a person confirms; an API key cannot call that Save, so it keeps this rename. Rename one of the organization's active or paused Discovery campaigns. Answers not found for any other id, including a campaign of another product.","deprecated":true,"tags":["discovery"],"x-cli-name":"discovery-campaigns-update","x-point11-scope":"discovery:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryCampaignsUpdateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryCampaignsUpdateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/ad-scopes/{id}":{"get":{"operationId":"discovery.ad-scopes.get.v1","summary":"Get ad scopes","description":"Resolve the Discovery scope an ad brief names: a customer campaign's name by its id and, when a loss reason id from its loss-reasons report is given, that reason's label in the report run the id names. Not found when either is not the organization's.","tags":["discovery"],"x-cli-name":"discovery-ad-scopes-get","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The Discovery campaign's id","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The Discovery campaign's id"}},{"name":"lossReasonId","in":"query","required":false,"description":"A loss reason's id from the campaign's loss-reasons report rows","schema":{"description":"A loss reason's id from the campaign's loss-reasons report rows","type":"string","minLength":1,"maxLength":1000}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryAdScopesGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/campaign-customers-v3":{"get":{"operationId":"discovery.campaign-customers.list.v3","summary":"List campaign customers (v3)","description":"Deprecated: use discovery.campaign-customers.list.v4 (discovery_campaign_customers_list_v4), which names no faviconLightUrl or faviconDarkUrl: a favicon is one image for both themes, faviconUrl. This version answers the same and names both, never sent. List a Discovery campaign's current customers a page at a time, newest first: every customer on its roster who is still active in its business profile, with their traits, audiences, and sources. query narrows by name or job title and groupIds to members of those audiences; selectedGroupIds also answers which of the matching customers belong to those audiences, across every page. A campaign your organization does not own is not found. Page with nextCursor at the same limit; manage the roster with discovery_roster_members_list_v3.","deprecated":true,"tags":["discovery"],"x-cli-name":"discovery-campaign-customers-list-v3","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"campaignId","in":"query","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"query","in":"query","required":false,"schema":{"type":"string","maxLength":200}},{"name":"groupIds","in":"query","required":false,"schema":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},{"name":"selectedGroupIds","in":"query","required":false,"schema":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},{"name":"filters","in":"query","required":false,"description":"Field conditions, each `<field>:<operator>:<value>`. Text fields (location, employer, trigger) take contains, does_not_contain, is or starts_with and the words. Number fields (age, householdIncome, companySize, annualRevenue) take gt, gte, lt, lte or eq and a number, or between and `min..max`. Classification fields, each band under its fact's key as <key>.band (gender, age.band, language, market, areaType, education, lifeStage, householdIncome.band, occupation, seniority, companySize.band, buyerType, audience, product, channel, buyerRole, intentStage, job, triggerType), take is_any_of or is_none_of and comma-separated ids from business_customer_filter_options_get_v2 (buyerType takes consumer or organization), `none` for a customer with no value. createdAt takes on_or_after or on_or_before and an ISO date, or between and `from..to`, read in UTC.","schema":{"description":"Field conditions, each `<field>:<operator>:<value>`. Text fields (location, employer, trigger) take contains, does_not_contain, is or starts_with and the words. Number fields (age, householdIncome, companySize, annualRevenue) take gt, gte, lt, lte or eq and a number, or between and `min..max`. Classification fields, each band under its fact's key as <key>.band (gender, age.band, language, market, areaType, education, lifeStage, householdIncome.band, occupation, seniority, companySize.band, buyerType, audience, product, channel, buyerRole, intentStage, job, triggerType), take is_any_of or is_none_of and comma-separated ids from business_customer_filter_options_get_v2 (buyerType takes consumer or organization), `none` for a customer with no value. createdAt takes on_or_after or on_or_before and an ISO date, or between and `from..to`, read in UTC.","maxItems":20,"type":"array","items":{"type":"string","minLength":5,"maxLength":4000,"pattern":"^[A-Za-z]+(?:\\.band)?:[a-z_]+:.+$"}}},{"name":"filterMatch","in":"query","required":false,"description":"Whether a customer matches every condition (all, the default) or any one","schema":{"description":"Whether a customer matches every condition (all, the default) or any one","type":"string","enum":["all","any"]}},{"name":"lifecycleStatus","in":"query","required":false,"description":"active (default): the campaign's customers on its roster now; archived: the customers it has held who are archived since; all: both.","schema":{"description":"active (default): the campaign's customers on its roster now; archived: the customers it has held who are archived since; all: both.","type":"string","enum":["active","archived","all"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryCampaignCustomersListV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/campaign-customers-v4":{"get":{"operationId":"discovery.campaign-customers.list.v4","summary":"List campaign customers (v4)","description":"List a Discovery campaign's current customers a page at a time, newest first: every customer on its roster who is still active in its business profile, with their traits, audiences, and sources. query narrows by name or job title and groupIds to members of those audiences; selectedGroupIds also answers which of the matching customers belong to those audiences, across every page. A campaign your organization does not own is not found. Page with nextCursor at the same limit; manage the roster with discovery_roster_members_list_v4.","tags":["discovery"],"x-cli-name":"discovery-campaign-customers-list-v4","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"campaignId","in":"query","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"query","in":"query","required":false,"schema":{"type":"string","maxLength":200}},{"name":"groupIds","in":"query","required":false,"schema":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},{"name":"selectedGroupIds","in":"query","required":false,"schema":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},{"name":"filters","in":"query","required":false,"description":"Field conditions, each `<field>:<operator>:<value>`. Text fields (location, employer, trigger) take contains, does_not_contain, is or starts_with and the words. Number fields (age, householdIncome, companySize, annualRevenue) take gt, gte, lt, lte or eq and a number, or between and `min..max`. Classification fields, each band under its fact's key as <key>.band (gender, age.band, language, market, areaType, education, lifeStage, householdIncome.band, occupation, seniority, companySize.band, buyerType, audience, product, channel, buyerRole, intentStage, job, triggerType), take is_any_of or is_none_of and comma-separated ids from business_customer_filter_options_get_v2 (buyerType takes consumer or organization), `none` for a customer with no value. createdAt takes on_or_after or on_or_before and an ISO date, or between and `from..to`, read in UTC.","schema":{"description":"Field conditions, each `<field>:<operator>:<value>`. Text fields (location, employer, trigger) take contains, does_not_contain, is or starts_with and the words. Number fields (age, householdIncome, companySize, annualRevenue) take gt, gte, lt, lte or eq and a number, or between and `min..max`. Classification fields, each band under its fact's key as <key>.band (gender, age.band, language, market, areaType, education, lifeStage, householdIncome.band, occupation, seniority, companySize.band, buyerType, audience, product, channel, buyerRole, intentStage, job, triggerType), take is_any_of or is_none_of and comma-separated ids from business_customer_filter_options_get_v2 (buyerType takes consumer or organization), `none` for a customer with no value. createdAt takes on_or_after or on_or_before and an ISO date, or between and `from..to`, read in UTC.","maxItems":20,"type":"array","items":{"type":"string","minLength":5,"maxLength":4000,"pattern":"^[A-Za-z]+(?:\\.band)?:[a-z_]+:.+$"}}},{"name":"filterMatch","in":"query","required":false,"description":"Whether a customer matches every condition (all, the default) or any one","schema":{"description":"Whether a customer matches every condition (all, the default) or any one","type":"string","enum":["all","any"]}},{"name":"lifecycleStatus","in":"query","required":false,"description":"active (default): the campaign's customers on its roster now; archived: the customers it has held who are archived since; all: both.","schema":{"description":"active (default): the campaign's customers on its roster now; archived: the customers it has held who are archived since; all: both.","type":"string","enum":["active","archived","all"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryCampaignCustomersListV4Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/roster-members-v3":{"get":{"operationId":"discovery.roster-members.list.v3","summary":"List roster members (v3)","description":"Deprecated: use discovery.roster-members.list.v4 (discovery_roster_members_list_v4), which names no faviconLightUrl or faviconDarkUrl: a favicon is one image for both themes, faviconUrl. This version answers the same and names both, never sent. List a Discovery campaign's customers (its roster): the current ones by default, or the removed ones, or all; searched by name, narrowed to audiences, and sorted. Each row is the customer with when it joined, whether and when it was removed, and its conversations, brand share and win rate in this campaign. Also answers the roster's counts, whether it can be changed now (and why not), and the audiences to narrow by.","deprecated":true,"tags":["discovery"],"x-cli-name":"discovery-roster-members-list-v3","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of customers to return (1–100)","schema":{"default":20,"description":"Number of customers to return (1–100)","type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"campaignId","in":"query","required":true,"description":"The Discovery campaign's id, or its campaign key.","schema":{"type":"string","minLength":1,"maxLength":100,"description":"The Discovery campaign's id, or its campaign key."}},{"name":"search","in":"query","required":false,"description":"Words a customer's name contains.","schema":{"description":"Words a customer's name contains.","type":"string","maxLength":200}},{"name":"audiences","in":"query","required":false,"description":"Source and label names: a customer in any named source and in any named label (system audiences are labels) is listed; a kind none names narrows nothing.","schema":{"description":"Source and label names: a customer in any named source and in any named label (system audiences are labels) is listed; a kind none names narrows nothing.","maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":120}}},{"name":"sortColumn","in":"query","required":false,"description":"Default createdAt.","schema":{"description":"Default createdAt.","type":"string","enum":["customerId","name","profile","performance","employer","location","audiences","sources","status","membershipStatus","conversations","brandShare","brandWinRate","age","householdIncome","headcount","annualRevenue","trigger","intentStage","language","createdAt"]}},{"name":"sortDirection","in":"query","required":false,"description":"Default desc.","schema":{"description":"Default desc.","type":"string","enum":["asc","desc"]}},{"name":"status","in":"query","required":false,"description":"Which memberships to list.","schema":{"default":"current","description":"Which memberships to list.","type":"string","enum":["current","removed","all"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryRosterMembersListV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/roster-members-v4":{"get":{"operationId":"discovery.roster-members.list.v4","summary":"List roster members (v4)","description":"List a Discovery campaign's customers (its roster): the current ones by default, or the removed ones, or all; searched by name, narrowed to audiences, and sorted. Each row is the customer with when it joined, whether and when it was removed, and its conversations, brand share and win rate in this campaign. Also answers the roster's counts, whether it can be changed now (and why not), and the audiences to narrow by.","tags":["discovery"],"x-cli-name":"discovery-roster-members-list-v4","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of customers to return (1–100)","schema":{"default":20,"description":"Number of customers to return (1–100)","type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"campaignId","in":"query","required":true,"description":"The Discovery campaign's id, or its campaign key.","schema":{"type":"string","minLength":1,"maxLength":100,"description":"The Discovery campaign's id, or its campaign key."}},{"name":"search","in":"query","required":false,"description":"Words a customer's name contains.","schema":{"description":"Words a customer's name contains.","type":"string","maxLength":200}},{"name":"audiences","in":"query","required":false,"description":"Source and label names: a customer in any named source and in any named label (system audiences are labels) is listed; a kind none names narrows nothing.","schema":{"description":"Source and label names: a customer in any named source and in any named label (system audiences are labels) is listed; a kind none names narrows nothing.","maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":120}}},{"name":"sortColumn","in":"query","required":false,"description":"Default createdAt.","schema":{"description":"Default createdAt.","type":"string","enum":["customerId","name","profile","performance","employer","location","audiences","sources","status","membershipStatus","conversations","brandShare","brandWinRate","age","householdIncome","headcount","annualRevenue","trigger","intentStage","language","createdAt"]}},{"name":"sortDirection","in":"query","required":false,"description":"Default desc.","schema":{"description":"Default desc.","type":"string","enum":["asc","desc"]}},{"name":"status","in":"query","required":false,"description":"Which memberships to list.","schema":{"default":"current","description":"Which memberships to list.","type":"string","enum":["current","removed","all"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryRosterMembersListV4Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/roster-candidates-v3":{"get":{"operationId":"discovery.roster-candidates.list.v3","summary":"List roster candidates (v3)","description":"Deprecated: use discovery.roster-candidates.list.v4 (discovery_roster_candidates_list_v4), which names no faviconLightUrl or faviconDarkUrl: a favicon is one image for both themes, faviconUrl. This version answers the same and names both, never sent. List the customers a Discovery campaign can add: only those who can join by default, or with `listing` every customer, those already added, or those not added, each with why it cannot join. Searched by name, narrowed to audiences, and sorted; also answers whether the roster can be changed now (and why not) and the audiences to narrow by.","deprecated":true,"tags":["discovery"],"x-cli-name":"discovery-roster-candidates-list-v3","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of customers to return (1–100)","schema":{"default":20,"description":"Number of customers to return (1–100)","type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"campaignId","in":"query","required":true,"description":"The Discovery campaign's id, or its campaign key.","schema":{"type":"string","minLength":1,"maxLength":100,"description":"The Discovery campaign's id, or its campaign key."}},{"name":"search","in":"query","required":false,"description":"Words a customer's name contains.","schema":{"description":"Words a customer's name contains.","type":"string","maxLength":200}},{"name":"audiences","in":"query","required":false,"description":"Source and label names: a customer in any named source and in any named label (system audiences are labels) is listed; a kind none names narrows nothing.","schema":{"description":"Source and label names: a customer in any named source and in any named label (system audiences are labels) is listed; a kind none names narrows nothing.","maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":120}}},{"name":"sortColumn","in":"query","required":false,"description":"Default createdAt.","schema":{"description":"Default createdAt.","type":"string","enum":["customerId","name","profile","performance","employer","location","audiences","sources","status","membershipStatus","conversations","brandShare","brandWinRate","age","householdIncome","headcount","annualRevenue","trigger","intentStage","language","createdAt"]}},{"name":"sortDirection","in":"query","required":false,"description":"Default desc.","schema":{"description":"Default desc.","type":"string","enum":["asc","desc"]}},{"name":"filters","in":"query","required":false,"description":"Field conditions, each `<field>:<operator>:<value>`. Text fields (location, employer, trigger) take contains, does_not_contain, is or starts_with and the words. Number fields (age, householdIncome, companySize, annualRevenue) take gt, gte, lt, lte or eq and a number, or between and `min..max`. Classification fields, each band under its fact's key as <key>.band (gender, age.band, language, market, areaType, education, lifeStage, householdIncome.band, occupation, seniority, companySize.band, buyerType, audience, product, channel, buyerRole, intentStage, job, triggerType), take is_any_of or is_none_of and comma-separated ids from business_customer_filter_options_get_v2 (buyerType takes consumer or organization), `none` for a customer with no value. createdAt takes on_or_after or on_or_before and an ISO date, or between and `from..to`, read in UTC.","schema":{"description":"Field conditions, each `<field>:<operator>:<value>`. Text fields (location, employer, trigger) take contains, does_not_contain, is or starts_with and the words. Number fields (age, householdIncome, companySize, annualRevenue) take gt, gte, lt, lte or eq and a number, or between and `min..max`. Classification fields, each band under its fact's key as <key>.band (gender, age.band, language, market, areaType, education, lifeStage, householdIncome.band, occupation, seniority, companySize.band, buyerType, audience, product, channel, buyerRole, intentStage, job, triggerType), take is_any_of or is_none_of and comma-separated ids from business_customer_filter_options_get_v2 (buyerType takes consumer or organization), `none` for a customer with no value. createdAt takes on_or_after or on_or_before and an ISO date, or between and `from..to`, read in UTC.","maxItems":20,"type":"array","items":{"type":"string","minLength":5,"maxLength":4000,"pattern":"^[A-Za-z]+(?:\\.band)?:[a-z_]+:.+$"}}},{"name":"filterMatch","in":"query","required":false,"description":"Whether a customer matches every condition (all, the default) or any one","schema":{"description":"Whether a customer matches every condition (all, the default) or any one","type":"string","enum":["all","any"]}},{"name":"listing","in":"query","required":false,"description":"`joinable` (default) lists only customers who can join; `all`, `added` and `not_added` list others too, each with why it cannot.","schema":{"default":"joinable","description":"`joinable` (default) lists only customers who can join; `all`, `added` and `not_added` list others too, each with why it cannot.","type":"string","enum":["joinable","all","added","not_added"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryRosterCandidatesListV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/roster-candidates-v4":{"get":{"operationId":"discovery.roster-candidates.list.v4","summary":"List roster candidates (v4)","description":"List the customers a Discovery campaign can add: only those who can join by default, or with `listing` every customer, those already added, or those not added, each with why it cannot join. Searched by name, narrowed to audiences, and sorted; also answers whether the roster can be changed now (and why not) and the audiences to narrow by.","tags":["discovery"],"x-cli-name":"discovery-roster-candidates-list-v4","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of customers to return (1–100)","schema":{"default":20,"description":"Number of customers to return (1–100)","type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"campaignId","in":"query","required":true,"description":"The Discovery campaign's id, or its campaign key.","schema":{"type":"string","minLength":1,"maxLength":100,"description":"The Discovery campaign's id, or its campaign key."}},{"name":"search","in":"query","required":false,"description":"Words a customer's name contains.","schema":{"description":"Words a customer's name contains.","type":"string","maxLength":200}},{"name":"audiences","in":"query","required":false,"description":"Source and label names: a customer in any named source and in any named label (system audiences are labels) is listed; a kind none names narrows nothing.","schema":{"description":"Source and label names: a customer in any named source and in any named label (system audiences are labels) is listed; a kind none names narrows nothing.","maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":120}}},{"name":"sortColumn","in":"query","required":false,"description":"Default createdAt.","schema":{"description":"Default createdAt.","type":"string","enum":["customerId","name","profile","performance","employer","location","audiences","sources","status","membershipStatus","conversations","brandShare","brandWinRate","age","householdIncome","headcount","annualRevenue","trigger","intentStage","language","createdAt"]}},{"name":"sortDirection","in":"query","required":false,"description":"Default desc.","schema":{"description":"Default desc.","type":"string","enum":["asc","desc"]}},{"name":"filters","in":"query","required":false,"description":"Field conditions, each `<field>:<operator>:<value>`. Text fields (location, employer, trigger) take contains, does_not_contain, is or starts_with and the words. Number fields (age, householdIncome, companySize, annualRevenue) take gt, gte, lt, lte or eq and a number, or between and `min..max`. Classification fields, each band under its fact's key as <key>.band (gender, age.band, language, market, areaType, education, lifeStage, householdIncome.band, occupation, seniority, companySize.band, buyerType, audience, product, channel, buyerRole, intentStage, job, triggerType), take is_any_of or is_none_of and comma-separated ids from business_customer_filter_options_get_v2 (buyerType takes consumer or organization), `none` for a customer with no value. createdAt takes on_or_after or on_or_before and an ISO date, or between and `from..to`, read in UTC.","schema":{"description":"Field conditions, each `<field>:<operator>:<value>`. Text fields (location, employer, trigger) take contains, does_not_contain, is or starts_with and the words. Number fields (age, householdIncome, companySize, annualRevenue) take gt, gte, lt, lte or eq and a number, or between and `min..max`. Classification fields, each band under its fact's key as <key>.band (gender, age.band, language, market, areaType, education, lifeStage, householdIncome.band, occupation, seniority, companySize.band, buyerType, audience, product, channel, buyerRole, intentStage, job, triggerType), take is_any_of or is_none_of and comma-separated ids from business_customer_filter_options_get_v2 (buyerType takes consumer or organization), `none` for a customer with no value. createdAt takes on_or_after or on_or_before and an ISO date, or between and `from..to`, read in UTC.","maxItems":20,"type":"array","items":{"type":"string","minLength":5,"maxLength":4000,"pattern":"^[A-Za-z]+(?:\\.band)?:[a-z_]+:.+$"}}},{"name":"filterMatch","in":"query","required":false,"description":"Whether a customer matches every condition (all, the default) or any one","schema":{"description":"Whether a customer matches every condition (all, the default) or any one","type":"string","enum":["all","any"]}},{"name":"listing","in":"query","required":false,"description":"`joinable` (default) lists only customers who can join; `all`, `added` and `not_added` list others too, each with why it cannot.","schema":{"default":"joinable","description":"`joinable` (default) lists only customers who can join; `all`, `added` and `not_added` list others too, each with why it cannot.","type":"string","enum":["joinable","all","added","not_added"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryRosterCandidatesListV4Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/roster-quotes/{id}":{"get":{"operationId":"discovery.roster-quotes.get.v1","summary":"Get roster quotes","description":"Price adding customers to a Discovery campaign before adding them: how many are not on its roster yet, the conversations they bring every monthly refresh, their estimated cost at today's price (it accrues against the plan as they run; the add charges nothing), and Billing's refusal when it would not admit that work. Refused, as the add would be, on a campaign that is not active or paused, a one-time campaign whose run has finished, or one whose first run is still choosing its customers. `id` is the campaign's id or its campaign key.","tags":["discovery"],"x-cli-name":"discovery-roster-quotes-get","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The Discovery campaign's id, or its campaign key.","schema":{"type":"string","minLength":1,"maxLength":100,"description":"The Discovery campaign's id, or its campaign key."}},{"name":"customerIds","in":"query","required":true,"description":"The customers' ids (1–1000)","schema":{"minItems":1,"maxItems":1000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":"The customers' ids (1–1000)"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryRosterQuotesGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/roster-members/add":{"post":{"operationId":"discovery.roster-members.add.v1","summary":"Add roster members","description":"Add customers to a Discovery campaign's roster. They join this month's calendar, so its next run interviews them, and their conversations accrue against the organization's plan. Refused on a campaign that is not active or paused or is a one-time campaign whose run has finished, while its first run is still choosing its customers, when any customer cannot join (each named with its reason), or when Billing would not admit the work; read discovery_roster_quotes_get first. Returns how many joined and when they start.","tags":["discovery"],"x-cli-name":"discovery-roster-members-add","x-point11-scope":"discovery:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryRosterMembersAddRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryRosterMembersAddResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/roster-members/remove":{"post":{"operationId":"discovery.roster-members.remove.v1","summary":"Remove roster members","description":"Remove customers from a Discovery campaign's roster at once: no later run interviews them, a conversation already started finishes, and past results stay. Refused on a campaign that is not active or paused or is a one-time campaign whose run has finished, or while its first run is still choosing its customers. Returns how many left.","tags":["discovery"],"x-cli-name":"discovery-roster-members-remove","x-point11-scope":"discovery:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryRosterMembersRemoveRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryRosterMembersRemoveResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/roster-members/replace":{"post":{"operationId":"discovery.roster-members.replace.v1","summary":"Replace roster members","description":"Replace one customer on a Discovery campaign's roster with another in one step: the first leaves at once and the replacement joins this month's calendar. Refused on a campaign that is not active or paused or is a one-time campaign whose run has finished, when the first is not on the roster, the replacement already is or cannot join, or while the campaign's first run is still choosing its customers. Returns when the replacement starts.","tags":["discovery"],"x-cli-name":"discovery-roster-members-replace","x-point11-scope":"discovery:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryRosterMembersReplaceRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryRosterMembersReplaceResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/dashboard-views":{"get":{"operationId":"discovery.dashboard-views.list.v1","summary":"List dashboard views","description":"List the Discovery dashboard views discovery_dashboard_views_get shows (Brand share, Brand win rate, Competitors, Brands map, Locations), each with its filters: its name, label, whether it is required and its accepted values. Pass campaignId to read that campaign's own: the brands brand_perspective can name and the days its results cover.","tags":["discovery"],"x-cli-name":"discovery-dashboard-views-list","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"campaignId","in":"query","required":false,"description":"Read this campaign's own brand and date values for each filter.","schema":{"description":"Read this campaign's own brand and date values for each filter.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryDashboardViewsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/dashboard-views/{id}":{"get":{"operationId":"discovery.dashboard-views.get.v1","summary":"Get dashboard views","description":"Show one Discovery dashboard view (Brand share, Brand win rate, Competitors, Brands map, Locations) exactly as the Point11 dashboard draws its card: its values as of the campaign's results window, each with its change against 30 days before, its trend and its precision. `id` is the campaign; `view`, date_range, brand_perspective and Locations' geography and geography_view are as discovery_dashboard_views_list lists them. Answers the view's title, applied filters and their labels, the results window, the card's display model (`snapshot`, which Point11's view renders) and the dashboard page that shows it (`canonicalHref`). A campaign with no results in the range is refused (PRECONDITION_FAILED).","tags":["discovery"],"x-cli-name":"discovery-dashboard-views-get","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Discovery campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Discovery campaign id."}},{"name":"view","in":"query","required":true,"description":"The dashboard view, as discovery_dashboard_views_list lists it.","schema":{"type":"string","enum":["discovery_brand_share_trend","discovery_brand_win_rate_trend","discovery_competitor_leaderboard","discovery_brand_map","discovery_win_rate_by_location"],"description":"The dashboard view, as discovery_dashboard_views_list lists it."}},{"name":"date_range","in":"query","required":true,"description":"Required. Use \"all\" or one absolute UTC-day range in yyyy-MM-dd..yyyy-MM-dd form. Preset names are not accepted because a saved answer must not move over time.","schema":{"type":"string","description":"Required. Use \"all\" or one absolute UTC-day range in yyyy-MM-dd..yyyy-MM-dd form. Preset names are not accepted because a saved answer must not move over time."}},{"name":"brand_perspective","in":"query","required":false,"description":"Optional exact brand name for the dashboard's read-only perspective. Omit for the campaign's target brand.","schema":{"description":"Optional exact brand name for the dashboard's read-only perspective. Omit for the campaign's target brand.","type":"string","minLength":1,"maxLength":240}},{"name":"geography","in":"query","required":false,"description":"Optional exact navigable dashboard-scope id or unambiguous visible label of a place with places under it, for example \"Texas\". Omit for World, the dashboard default scope.","schema":{"description":"Optional exact navigable dashboard-scope id or unambiguous visible label of a place with places under it, for example \"Texas\". Omit for World, the dashboard default scope.","type":"string","minLength":1,"maxLength":240}},{"name":"geography_view","in":"query","required":false,"description":"Optional. \"list\" for the ranked table, or \"map\" for the countries filled on a world map, which is drawn only at World (no geography). Omit for the map where it can be drawn, else the list.","schema":{"description":"Optional. \"list\" for the ranked table, or \"map\" for the countries filled on a world map, which is drawn only at World (no geography). Omit for the map where it can be drawn, else the list.","type":"string","enum":["map","list"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryDashboardViewsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/dashboard-view-images/create":{"post":{"operationId":"discovery.dashboard-view-images.create.v1","summary":"Create dashboard view images","description":"Draw 1 to 12 Discovery dashboard views as PNG images for slides, documents or messages, each exactly the card the Point11 dashboard draws with a footer naming its view, campaign, filters, results window and as-of day; each `views` entry is a view as discovery_dashboard_views_get takes it (discovery_dashboard_views_list lists them). Answers each image's id, size, provenance, a small preview and a download link that works for five minutes (discovery_dashboard_view_images_download fetches the file again); an identical image is answered without drawing it again, images are kept 30 days, and drawing them is free.","tags":["discovery"],"x-cli-name":"discovery-dashboard-view-images-create","x-point11-scope":"discovery:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryDashboardViewImagesCreateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryDashboardViewImagesCreateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/dashboard-view-images/{id}":{"get":{"operationId":"discovery.dashboard-view-images.get.v1","summary":"Get dashboard view images","description":"Read one image discovery_dashboard_view_images_create drew: its view, campaign, filters, results window, frame and size, and when it stops being kept; discovery_dashboard_view_images_download fetches its file. Not found once it is gone (after 30 days, or once its campaign is deleted).","tags":["discovery"],"x-cli-name":"discovery-dashboard-view-images-get","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The image's id, as discovery_dashboard_view_images_create answered it.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The image's id, as discovery_dashboard_view_images_create answered it."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryDashboardViewImagesGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/discovery/dashboard-view-images/download":{"get":{"operationId":"discovery.dashboard-view-images.download.v1","summary":"Download dashboard view images","description":"Download one image discovery_dashboard_view_images_create drew, as its PNG file: its name, media type and size, and a short-lived url that GETs its bytes (null when this deployment cannot sign one).","tags":["discovery"],"x-cli-name":"discovery-dashboard-view-images-download","x-point11-scope":"discovery:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"query","required":true,"description":"The image's id, as discovery_dashboard_view_images_create answered it.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The image's id, as discovery_dashboard_view_images_create answered it."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryDashboardViewImagesDownloadResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/creative-models/{id}":{"get":{"operationId":"alpha.creative-models.get.v1","summary":"Get creative models","description":"Read Studio's available creative models and the managed defaults a project freezes when it names none.","tags":["alpha"],"x-cli-name":"alpha-creative-models-get","x-point11-scope":"alpha:read","security":[{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","const":"current"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaCreativeModelsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/creative-catalog/{id}":{"get":{"operationId":"alpha.creative-catalog.get.v1","summary":"Get creative catalog","description":"Read Studio’s published platform specifications and their verification dates.","tags":["alpha"],"x-cli-name":"alpha-creative-catalog-get","x-point11-scope":"alpha:read","security":[{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","const":"current"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaCreativeCatalogGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/creative-projects":{"get":{"operationId":"alpha.creative-projects.list.v1","summary":"List creative projects","description":"List the member’s saved Studio projects.","tags":["alpha"],"x-cli-name":"alpha-creative-projects-list","x-point11-scope":"alpha:read","security":[{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"query","in":"query","required":false,"description":"Matches project names","schema":{"description":"Matches project names","type":"string","minLength":1,"maxLength":120}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaCreativeProjectsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/creative-projects/{id}":{"get":{"operationId":"alpha.creative-projects.get.v1","summary":"Get creative projects","description":"Read a saved creative project and one page of its rounds, newest first (roundsCursor continues with nextRoundsCursor): each round's request, any refusal, and its immutable alternatives; and deliveredFileCount, the distinct files every round of the project delivered, whichever page is read. A project whose conversation was deleted is not found.","tags":["alpha"],"x-cli-name":"alpha-creative-projects-get","x-point11-scope":"alpha:read","security":[{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"roundsCursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":500}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaCreativeProjectsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/creative-projects/create":{"post":{"operationId":"alpha.creative-projects.create.v1","summary":"Create creative projects","description":"Create a Studio project and its private Alpha conversation. The brand is the chosen Brand Kit revision, none, or by default Alpha's brand order; it is frozen on the project and every round.","tags":["alpha"],"x-cli-name":"alpha-creative-projects-create","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaCreativeProjectsCreateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaCreativeProjectsCreateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/creative-projects/update":{"post":{"operationId":"alpha.creative-projects.update.v1","summary":"Update creative projects","description":"Save the creative brief, name and optionally the brand against the project's current revision; rounds already made keep what they froze.","tags":["alpha"],"x-cli-name":"alpha-creative-projects-update","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaCreativeProjectsUpdateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaCreativeProjectsUpdateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/creative-projects/select":{"post":{"operationId":"alpha.creative-projects.select.v1","summary":"Select creative projects","description":"Select an exact creative artifact version without starting generation.","tags":["alpha"],"x-cli-name":"alpha-creative-projects-select","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaCreativeProjectsSelectRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaCreativeProjectsSelectResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/creative-rounds/{id}":{"get":{"operationId":"alpha.creative-rounds.get.v1","summary":"Get creative rounds","description":"Read the frozen brief and source version for a creative generation round.","tags":["alpha"],"x-cli-name":"alpha-creative-rounds-get","x-point11-scope":"alpha:read","security":[{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaCreativeRoundsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/creative-rounds/create":{"post":{"operationId":"alpha.creative-rounds.create.v1","summary":"Create creative rounds","description":"Start a round on a project: five alternatives or an instructed edit of a selected version through Alpha's metered turn, under the Studio pricing; or an exact media edit (crop, orientation, color, trim, speed, volume, fades) of one saved image, video or audio file, rendered with no model turn and free. The member sends only their own words and choices. A refusal is recorded on the round, which never blocks a new request; resend only roundId to resume a request whose answer was lost.","tags":["alpha"],"x-cli-name":"alpha-creative-rounds-create","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaCreativeRoundsCreateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaCreativeRoundsCreateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/availability/{id}":{"get":{"operationId":"alpha.availability.get.v1","summary":"Get availability","description":"Get whether new Alpha work may start for the organization (id \"organization\"): visible, or closed with Billing's reason the account refuses new work, or an operator's pause. Every Alpha write that starts work refuses the same way while closed; reads are never closed.","tags":["alpha"],"x-cli-name":"alpha-availability-get","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Always \"organization\": the caller's own","schema":{"type":"string","const":"organization","description":"Always \"organization\": the caller's own"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAvailabilityGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/workflows":{"get":{"operationId":"alpha.workflows.list.v1","summary":"List workflows","description":"List the organization's Alpha workflows (scheduled and on-demand reports) with each one's publication, latest run, and schedule state, and the total that match. Sort by last run (the default, newest first), name, origin, publication status, schedule, or delivery, in either direction.","tags":["alpha"],"x-cli-name":"alpha-workflows-list","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"query","in":"query","required":false,"description":"Only workflows whose name contains this text, ignoring case","schema":{"description":"Only workflows whose name contains this text, ignoring case","type":"string","minLength":1,"maxLength":120}},{"name":"sort","in":"query","required":false,"description":"lastRunAt: the latest run's start, a workflow never run counting as oldest. name: ignoring case, digits as numbers. origin: the raw origin value. status: Draft before Published. schedule: daily, weekly, monthly, then unscheduled. delivery: its label (\"In Alpha\" or \"Slack <channel>\"), unscheduled first. Ties keep the most recently updated first","schema":{"default":"lastRunAt","description":"lastRunAt: the latest run's start, a workflow never run counting as oldest. name: ignoring case, digits as numbers. origin: the raw origin value. status: Draft before Published. schedule: daily, weekly, monthly, then unscheduled. delivery: its label (\"In Alpha\" or \"Slack <channel>\"), unscheduled first. Ties keep the most recently updated first","type":"string","enum":["lastRunAt","name","origin","status","schedule","delivery"]}},{"name":"direction","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaWorkflowsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/workflows/{id}":{"get":{"operationId":"alpha.workflows.get.v1","summary":"Get workflows","description":"Deprecated: use alpha.workflows.get.v2 (alpha_workflows_get_v2), which reads every graph version, version 5 file steps included. This version gets one Alpha workflow by its workflow key: its draft graph and revision, its published version, and its recent runs; a workflow whose graph uses graph version 5 (file steps) is refused (409 WORKFLOW_GRAPH_VERSION_UNSUPPORTED).","deprecated":true,"tags":["alpha"],"x-cli-name":"alpha-workflows-get","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^wf_[a-f0-9]{32}$"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaWorkflowsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/workflows-v2/{id}":{"get":{"operationId":"alpha.workflows.get.v2","summary":"Get workflows (v2)","description":"Get one Alpha workflow by its workflow key: its draft graph (every graph version, including version 5 file steps) and revision, its published version, and its recent runs with the files they built.","tags":["alpha"],"x-cli-name":"alpha-workflows-get-v2","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^wf_[a-f0-9]{32}$"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaWorkflowsGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/workflows/create":{"post":{"operationId":"alpha.workflows.create.v1","summary":"Create workflows","description":"Create a data report workflow draft from a name and instructions: each run reads the organization's Point11 data and writes one report as the instructions ask. A retry with the same idempotency key returns the same workflow. Returns its workflow key; publish it with alpha_workflows_publish before starting or scheduling it.","tags":["alpha"],"x-cli-name":"alpha-workflows-create","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaWorkflowsCreateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaWorkflowsCreateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/solution-design-workflows/create":{"post":{"operationId":"alpha.solution-design-workflows.create.v1","summary":"Create solution design workflows","description":"Create a solution-design workflow draft from a succeeded Alpha report, for a named audience and goal. Returns its workflow key; publish it before starting it.","tags":["alpha"],"x-cli-name":"alpha-solution-design-workflows-create","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaSolutionDesignWorkflowsCreateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaSolutionDesignWorkflowsCreateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/workflows/update":{"post":{"operationId":"alpha.workflows.update.v1","summary":"Update workflows","description":"Save a workflow's draft graph, naming the draft revision it was edited from; a newer draft is a conflict to reload, never overwritten.","tags":["alpha"],"x-cli-name":"alpha-workflows-update","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaWorkflowsUpdateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaWorkflowsUpdateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/workflows/publish":{"post":{"operationId":"alpha.workflows.publish.v1","summary":"Publish workflows","description":"Publish a workflow's current draft revision as a new immutable version that later runs use.","tags":["alpha"],"x-cli-name":"alpha-workflows-publish","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaWorkflowsPublishRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaWorkflowsPublishResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/workflows/start":{"post":{"operationId":"alpha.workflows.start.v1","summary":"Start workflows","description":"Start one run of a published Alpha workflow, using the organization's Alpha credits; a retry with the same idempotency key returns the same run. Follow the run with alpha_workflows_get_v2 (its recentRuns); an internal-report run is also readable by runId through alpha_reports_get, then alpha_report_results_get_v2 once it has succeeded.","tags":["alpha"],"x-cli-name":"alpha-workflows-start","x-point11-scope":"alpha:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaWorkflowsStartRequest"}}}},"responses":{"202":{"description":"Accepted: the durable run started. Follow it with `GET /api/v1/platform/runs-v2/{id}`.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaWorkflowsStartResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/workflow-artifacts/download":{"get":{"operationId":"alpha.workflow-artifacts.download.v1","summary":"Download workflow artifacts","description":"Download a file a workflow run wrote, by the artifactId alpha_workflows_get_v2 lists on its recent runs: the landing-page mock of a solution-design run, or the PowerPoint, Excel, Word or PDF file a file step built. Answers its file name, type and size, and a short-lived url that GETs its bytes (null when this deployment cannot sign one). A landing-page mock is raw, untrusted model-written HTML for saving; never render it on a trusted origin.","tags":["alpha"],"x-cli-name":"alpha-workflow-artifacts-download","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"query","required":true,"description":"The run artifact's artifactId","schema":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The run artifact's artifactId"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaWorkflowArtifactsDownloadResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/reports/{id}":{"get":{"operationId":"alpha.reports.get.v1","summary":"Get reports","description":"Get the status, immutable workflow version, and source labels of an Alpha report run by the runId its start returned. Carries no report content.","tags":["alpha"],"x-cli-name":"alpha-reports-get","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Alpha report ID (the report's run ID)","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Alpha report ID (the report's run ID)"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaReportsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/report-results/{id}":{"get":{"operationId":"alpha.report-results.get.v1","summary":"Get report results","description":"Deprecated: use alpha.report-results.get.v2 (alpha_report_results_get_v2), which answers a run that has not succeeded yet with its status and a null result. Get the accepted report text and source labels of a succeeded Alpha report run by its runId. A run that has not succeeded yet is a conflict.","deprecated":true,"tags":["alpha"],"x-cli-name":"alpha-report-results-get","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Alpha report ID (the report's run ID)","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Alpha report ID (the report's run ID)"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaReportResultsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/report-results-v2/{id}":{"get":{"operationId":"alpha.report-results.get.v2","summary":"Get report results (v2)","description":"Get an Alpha report run by the runId its start returned: its status, immutable workflow version and source labels and, once it has succeeded, its accepted report text (result, null until then).","tags":["alpha"],"x-cli-name":"alpha-report-results-get-v2","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Alpha report ID (the report's run ID)","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Alpha report ID (the report's run ID)"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaReportResultsGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/brand-kits":{"get":{"operationId":"alpha.brand-kits.list.v1","summary":"List brand kits","description":"List the organization's active Brand Kits, most recently changed first; filter by name with query, or pass website to find the one kit that owns that site.","tags":["alpha"],"x-cli-name":"alpha-brand-kits-list","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"query","in":"query","required":false,"schema":{"type":"string","maxLength":120}},{"name":"website","in":"query","required":false,"schema":{"type":"string","maxLength":2048,"format":"uri"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaBrandKitsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/brand-kits/{id}":{"get":{"operationId":"alpha.brand-kits.get.v1","summary":"Get brand kits","description":"Deprecated: use alpha.brand-kits.get.v2 (alpha_brand_kits_get_v2), which reads a revision in its own version, .potx and .dotx template packages included. Get one Brand Kit by its kit key with its current revision document, or an exact earlier revision by its artifact id. A revision a file import added reads with origin manual. It answers in the values it was published with: a version 3 revision is given in its version 2 form, and a .potx or .dotx template package, which only v2 names, is left out of the document's assetUsage.","deprecated":true,"tags":["alpha"],"x-cli-name":"alpha-brand-kits-get","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":160}},{"name":"revision","in":"query","required":false,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaBrandKitsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/brand-kits-v2/{id}":{"get":{"operationId":"alpha.brand-kits.get.v2","summary":"Get brand kits (v2)","description":"Get one Brand Kit by its kit key with its current revision document in its own version, or an exact earlier revision by its artifact id. A version 3 document carries the type scale, colour roles, spacing, radii and components, format guidance, the approved-claims library and terminology to use and avoid; its assetUsage names every asset, .potx and .dotx template packages included.","tags":["alpha"],"x-cli-name":"alpha-brand-kits-get-v2","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":160}},{"name":"revision","in":"query","required":false,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaBrandKitsGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/brand-kit-workspaces/{id}":{"get":{"operationId":"alpha.brand-kit-workspaces.get.v1","summary":"Get brand kit workspaces","description":"Deprecated: use alpha.brand-kit-workspaces.get.v2 (alpha_brand_kit_workspaces_get_v2), which reads a named kit's revision in its own version, .potx and .dotx template packages included. Get the Brand Kit inventory for the organization (id \"organization\"), one business profile (its id), or the business profile selected by default (id \"default\", which profileBinding names; the organization when it has no active profile): each kit's default or active status and the defaults' versions. A named kit's revision a file import added reads with origin manual. Name a kit to also get it, its revision, and its first page of runs. It answers in the values it was published with: a version 3 revision is given in its version 2 form, and a .potx or .dotx template package, which only v2 names, is left out of the document's assetUsage.","deprecated":true,"tags":["alpha"],"x-cli-name":"alpha-brand-kit-workspaces-get","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","const":"organization"},{"type":"string","const":"default"},{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}]}},{"name":"kitPage","in":"query","required":false,"schema":{"default":0,"type":"integer","minimum":0,"maximum":100000}},{"name":"query","in":"query","required":false,"description":"Only kits whose name contains this text, ignoring case","schema":{"description":"Only kits whose name contains this text, ignoring case","type":"string","maxLength":120}},{"name":"sort","in":"query","required":false,"description":"updatedAt: the kit's last change. name: ignoring case","schema":{"default":"updatedAt","description":"updatedAt: the kit's last change. name: ignoring case","type":"string","enum":["updatedAt","name"]}},{"name":"direction","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}},{"name":"status","in":"query","required":false,"description":"Which kits to list: active ones, or archived (retired) ones, read only","schema":{"default":"active","description":"Which kits to list: active ones, or archived (retired) ones, read only","type":"string","enum":["active","archived"]}},{"name":"kit","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":160}},{"name":"revision","in":"query","required":false,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaBrandKitWorkspacesGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/brand-kit-workspaces-v2/{id}":{"get":{"operationId":"alpha.brand-kit-workspaces.get.v2","summary":"Get brand kit workspaces (v2)","description":"Get the Brand Kit inventory for the organization (id \"organization\"), one business profile (its id), or the business profile selected by default (id \"default\", which profileBinding names; the organization when it has no active profile): each kit's default or active status and the defaults' versions. A named kit's revision a file import added reads with origin manual. Name a kit to also get it, its revision with its document in its own version (version 3 included, every asset named, .potx and .dotx template packages included), and its first page of runs.","tags":["alpha"],"x-cli-name":"alpha-brand-kit-workspaces-get-v2","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","const":"organization"},{"type":"string","const":"default"},{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}]}},{"name":"kitPage","in":"query","required":false,"schema":{"default":0,"type":"integer","minimum":0,"maximum":100000}},{"name":"query","in":"query","required":false,"description":"Only kits whose name contains this text, ignoring case","schema":{"description":"Only kits whose name contains this text, ignoring case","type":"string","maxLength":120}},{"name":"sort","in":"query","required":false,"description":"updatedAt: the kit's last change. name: ignoring case","schema":{"default":"updatedAt","description":"updatedAt: the kit's last change. name: ignoring case","type":"string","enum":["updatedAt","name"]}},{"name":"direction","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}},{"name":"status","in":"query","required":false,"description":"Which kits to list: active ones, or archived (retired) ones, read only","schema":{"default":"active","description":"Which kits to list: active ones, or archived (retired) ones, read only","type":"string","enum":["active","archived"]}},{"name":"kit","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":160}},{"name":"revision","in":"query","required":false,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaBrandKitWorkspacesGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/brand-kit-runs":{"get":{"operationId":"alpha.brand-kit-runs.list.v1","summary":"List brand kit runs","description":"List a Brand Kit's extraction runs, newest first, with each run's outcome and execution status.","tags":["alpha"],"x-cli-name":"alpha-brand-kit-runs-list","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–100)","schema":{"default":20,"description":"Number of items to return (1–100)","type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"kitKey","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":160}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaBrandKitRunsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/brand-kits/create":{"post":{"operationId":"alpha.brand-kits.create.v1","summary":"Create brand kits","description":"Create a Brand Kit for a website (or return the kit that already owns it) and start extracting its brand; a refused extraction is returned as the outcome, with the kit kept.","tags":["alpha"],"x-cli-name":"alpha-brand-kits-create","x-point11-scope":"alpha:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaBrandKitsCreateRequest"}}}},"responses":{"202":{"description":"Accepted: the durable run started. Follow it with `GET /api/v1/platform/runs-v2/{id}`.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaBrandKitsCreateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/brand-kits/refresh":{"post":{"operationId":"alpha.brand-kits.refresh.v1","summary":"Refresh brand kits","description":"Re-extract a Brand Kit from its source website, naming the kit version it was read at; customer edits survive the refresh.","tags":["alpha"],"x-cli-name":"alpha-brand-kits-refresh","x-point11-scope":"alpha:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaBrandKitsRefreshRequest"}}}},"responses":{"202":{"description":"Accepted: the durable run started. Follow it with `GET /api/v1/platform/runs-v2/{id}`.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaBrandKitsRefreshResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/brand-kits/update":{"post":{"operationId":"alpha.brand-kits.update.v1","summary":"Update brand kits","description":"Deprecated: use alpha.brand-kits.update.v2 (alpha_brand_kits_update_v2), whose document names every asset, .potx and .dotx template packages included. Publish an edited Brand Kit document as a new revision, naming the kit version it was edited from; if the kit moved first, the edit is kept as a candidate to review. Needs a signed-in member. Its document names what a v1 read names, so the kit's .potx and .dotx template packages, which a v1 read leaves out, are kept as they are.","deprecated":true,"tags":["alpha"],"x-cli-name":"alpha-brand-kits-update","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaBrandKitsUpdateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaBrandKitsUpdateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/brand-kits/update-v2":{"post":{"operationId":"alpha.brand-kits.update.v2","summary":"Update brand kits (v2)","description":"Publish an edited Brand Kit document as a new revision, naming the kit version it was edited from; if the kit moved first, the edit is kept as a candidate to review. Needs a signed-in member. Its document names every asset, as alpha_brand_kits_get_v2 reads it, .potx and .dotx template packages included.","tags":["alpha"],"x-cli-name":"alpha-brand-kits-update-v2","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaBrandKitsUpdateV2Request"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaBrandKitsUpdateV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/brand-kits/restore":{"post":{"operationId":"alpha.brand-kits.restore.v1","summary":"Restore brand kits","description":"Publish an earlier revision of a Brand Kit again as its newest revision, naming the kit version it was read at. Needs a signed-in member.","tags":["alpha"],"x-cli-name":"alpha-brand-kits-restore","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaBrandKitsRestoreRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaBrandKitsRestoreResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/brand-kits/set-default":{"post":{"operationId":"alpha.brand-kits.set-default.v1","summary":"Set default brand kits","description":"Make a Brand Kit the organization's default, or one business profile's kit when profileId is given.","tags":["alpha"],"x-cli-name":"alpha-brand-kits-set-default","x-point11-scope":"alpha:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaBrandKitsSetDefaultRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaBrandKitsSetDefaultResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/brand-kits/retire":{"post":{"operationId":"alpha.brand-kits.retire.v1","summary":"Retire brand kits","description":"Retire a Brand Kit: it leaves automatic selection and frees its website, while revisions already pinned by work keep reading. This cannot be undone.","tags":["alpha"],"x-cli-name":"alpha-brand-kits-retire","x-point11-scope":"alpha:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaBrandKitsRetireRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaBrandKitsRetireResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/brand-kit-assets/reserve-upload":{"post":{"operationId":"alpha.brand-kit-assets.reserve-upload.v1","summary":"Reserve upload brand kit assets","description":"Reserve an original asset for an active Brand Kit (a PNG, JPEG, WebP or SVG image, a WOFF, WOFF2, TTF or OTF font, or a DOCX, PPTX, XLSX or PDF document, at most 20 MiB), declaring its role, usage, label, media type, size and SHA-256. Returns the asset and one presigned upload: send the file as the body of exactly that request before it expires, then call alpha_brand_kit_assets_complete_upload. A kit revision names the asset by its artifactId.","tags":["alpha"],"x-cli-name":"alpha-brand-kit-assets-reserve-upload","x-point11-scope":"alpha:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaBrandKitAssetsReserveUploadRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaBrandKitAssetsReserveUploadResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/brand-kit-assets/complete-upload":{"post":{"operationId":"alpha.brand-kit-assets.complete-upload.v1","summary":"Complete upload brand kit assets","description":"Finish a Brand Kit asset after its upload: the stored file is read back, must match the reserved size and SHA-256, and its bytes must prove its declared type. Pass the etag the upload answered, or omit it to recover from the store. Returns the asset, ready to name in a kit revision; retrying is safe.","tags":["alpha"],"x-cli-name":"alpha-brand-kit-assets-complete-upload","x-point11-scope":"alpha:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaBrandKitAssetsCompleteUploadRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaBrandKitAssetsCompleteUploadResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/brand-kit-artifacts/download":{"get":{"operationId":"alpha.brand-kit-artifacts.download.v1","summary":"Download brand kit artifacts","description":"Download one Brand Kit file by artifactId: an original asset, or an accepted revision's document as JSON. Returns its file name, type and size, and a short-lived url that GETs its bytes (null when this deployment cannot sign one).","tags":["alpha"],"x-cli-name":"alpha-brand-kit-artifacts-download","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"query","required":true,"description":"The asset's or revision's artifactId.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The asset's or revision's artifactId."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaBrandKitArtifactsDownloadResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/brand-kit-imports/create":{"post":{"operationId":"alpha.brand-kit-imports.create.v1","summary":"Create brand kit imports","description":"Declare a batch of files (1 to 64: name, media type, size and SHA-256 each) to import into an active Brand Kit. Returns the import and, per file, one presigned upload to send its bytes with, or why it was refused (the kit already holds the same file, or has no room for it under its 64 assets). Retrying with the same Idempotency-Key and body answers the same import with fresh uploads for the files still waiting for their bytes. Then call alpha_brand_kit_imports_start. Needs a signed-in member: the revision an import adds is that member's, as an edit's is, and records their licence for each font it embeds.","tags":["alpha"],"x-cli-name":"alpha-brand-kit-imports-create","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaBrandKitImportsCreateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaBrandKitImportsCreateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/brand-kit-imports/start":{"post":{"operationId":"alpha.brand-kit-imports.start.v1","summary":"Start brand kit imports","description":"Start an import once its files are uploaded: each file is checked (it landed, its bytes are its declared type, an Office file carries no macros, ActiveX controls or embedded objects), then a model identifies each admitted file's role and the identified files are added to the kit in one new revision. Importing is free. Calling it again answers the same run. Read the outcome with alpha_brand_kit_imports_get. Needs a signed-in member.","tags":["alpha"],"x-cli-name":"alpha-brand-kit-imports-start","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaBrandKitImportsStartRequest"}}}},"responses":{"202":{"description":"Accepted: the durable run started. Follow it with `GET /api/v1/platform/runs-v2/{id}`.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaBrandKitImportsStartResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/brand-kit-imports/{id}":{"get":{"operationId":"alpha.brand-kit-imports.get.v1","summary":"Get brand kit imports","description":"Get one Brand Kit import by id: its status, the revision it added its files in and the kit version it published, the revision to restore to undo it (alpha_brand_kits_restore), and each file's status (uploading, identifying, added, needs_decision or refused) with the role and label it was added as, why it needs a decision, or why it was refused. Place a file that needs a decision with alpha_brand_kits_update_v2, naming its artifactId.","tags":["alpha"],"x-cli-name":"alpha-brand-kit-imports-get","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The importId create answered.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The importId create answered."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaBrandKitImportsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/brand-kit-imports":{"get":{"operationId":"alpha.brand-kit-imports.list.v1","summary":"List brand kit imports","description":"List a Brand Kit's imports, newest first, each with its status and its files.","tags":["alpha"],"x-cli-name":"alpha-brand-kit-imports-list","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"kitKey","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":160}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaBrandKitImportsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/creative-activities/{id}":{"get":{"operationId":"alpha.creative-activities.get.v1","summary":"Get creative activities","description":"Read what Studio is doing for you now (id \"organization\"): rounds of your own creative projects whose model turn is admitted or running, your creative tests Research is preparing or running, and the organization's included ad suite while its creation run runs. reading is running (with how many) or idle; Studio schedules nothing. subject names the one creative project when exactly one of yours holds the work.","tags":["alpha"],"x-cli-name":"alpha-creative-activities-get","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","const":"organization"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaCreativeActivitiesGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/ad-suites":{"get":{"operationId":"alpha.ad-suites.list.v1","summary":"List ad suites","description":"List the organization's Alpha ad suites, newest first, optionally for one campaign or loss reason, with each suite's review state and pinned Brand Kit revision.","tags":["alpha"],"x-cli-name":"alpha-ad-suites-list","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"campaignId","in":"query","required":false,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"query","in":"query","required":false,"description":"Matches suite names","schema":{"description":"Matches suite names","type":"string","minLength":1,"maxLength":120}},{"name":"lossReasonId","in":"query","required":false,"description":"A published loss reason's report id; needs campaignId","schema":{"description":"A published loss reason's report id; needs campaignId","type":"string","minLength":1,"maxLength":200}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdSuitesListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/ad-suites/{id}":{"get":{"operationId":"alpha.ad-suites.get.v1","summary":"Get ad suites","description":"Get one ad suite with its current (or a named) revision, its versions, assets, and review history.","tags":["alpha"],"x-cli-name":"alpha-ad-suites-get","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"revision","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},{"name":"includeAssetUrls","in":"query","required":false,"description":"Presign each asset's url (default); false answers every url and urlExpiresAt as null, for a caller that reads the bytes elsewhere","schema":{"default":true,"description":"Presign each asset's url (default); false answers every url and urlExpiresAt as null, for a caller that reads the bytes elsewhere","type":"boolean"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdSuitesGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/ad-suites/review":{"post":{"operationId":"alpha.ad-suites.review.v1","summary":"Review ad suites","description":"Approve an ad suite revision or request changes to it, with an optional note; name the revision reviewed.","tags":["alpha"],"x-cli-name":"alpha-ad-suites-review","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdSuitesReviewRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdSuitesReviewResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/ad-suite-assets/download":{"get":{"operationId":"alpha.ad-suite-assets.download.v1","summary":"Download ad suite assets","description":"Download one stored asset of an accepted ad suite revision (an artifactId from alpha_ad_suites_get assets): its file name, type and size, and a short-lived url that GETs its bytes (null when this deployment cannot sign one).","tags":["alpha"],"x-cli-name":"alpha-ad-suite-assets-download","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"query","required":true,"description":"The asset's artifactId","schema":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The asset's artifactId"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdSuiteAssetsDownloadResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/ad-suites/export":{"get":{"operationId":"alpha.ad-suites.export.v1","summary":"Export ad suites","description":"Export one accepted revision of an ad suite (a revision from alpha_ad_suites_get versions) as the files of its package: ad-suite.json, the copy CSVs, test plan, evidence, placements, README, every stored asset, and any website deliverable's source. Each stored file carries a short-lived url that GETs its bytes; each generated file carries its content inline.","tags":["alpha"],"x-cli-name":"alpha-ad-suites-export","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"revision","in":"query","required":true,"description":"The accepted revision to export","schema":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"The accepted revision to export"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdSuitesExportResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/ad-bootstraps":{"get":{"operationId":"alpha.ad-bootstraps.list.v1","summary":"List ad bootstraps","description":"List the ad suites included with the organization's campaigns and where each stands: waiting for a brand choice, generating, ready, or needing recovery.","tags":["alpha"],"x-cli-name":"alpha-ad-bootstraps-list","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"campaignId","in":"query","required":false,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdBootstrapsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/ad-bootstraps/choose-brand":{"post":{"operationId":"alpha.ad-bootstraps.choose-brand.v1","summary":"Choose brand ad bootstraps","description":"Choose the Brand Kit revision (or explicitly no brand) a campaign's included ad suite is generated with, and let its generation continue.","tags":["alpha"],"x-cli-name":"alpha-ad-bootstraps-choose-brand","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdBootstrapsChooseBrandRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdBootstrapsChooseBrandResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/ad-bootstraps/recover":{"post":{"operationId":"alpha.ad-bootstraps.recover.v1","summary":"Recover ad bootstraps","description":"Resume a campaign's included ad suite whose generation stopped, at no extra charge.","tags":["alpha"],"x-cli-name":"alpha-ad-bootstraps-recover","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdBootstrapsRecoverRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdBootstrapsRecoverResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/advisor-actions":{"get":{"operationId":"alpha.advisor-actions.list.v1","summary":"List advisor actions","description":"Deprecated: use alpha.advisor-actions.list.v3 (alpha_advisor_actions_list_v3), which lists every action on the organization's Advisor list with its section, place, current content revision, value, newest status change and latest outcome. This version lists Discovery's actions only, in the shape it was published with: an action whose content names no live Discovery campaign is left out; impact.liftPp is the expected effect's estimate (0 without one), priorityScore and reach are 0, the evidence arrays are empty with evidenceSummary the action's body, and latestDecision and outcome are null. `campaigns` lists the live Discovery campaigns that have published, each dispatchId its newest publication. Sorted by impact (the lift's modeled annual value) unless another sort is named; filter by campaign, status (open, completed, dismissed, or all), area, or title, or open on the page that holds one action.","deprecated":true,"tags":["alpha"],"x-cli-name":"alpha-advisor-actions-list","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"campaignId","in":"query","required":false,"description":"Only this campaign's actions","schema":{"description":"Only this campaign's actions","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"product","in":"query","required":false,"description":"Only actions of this product","schema":{"description":"Only actions of this product","type":"string","enum":["discovery","experience"]}},{"name":"status","in":"query","required":false,"description":"Open (work still to do), completed, dismissed, or every action; open when omitted, or the named action's own status. A cursor names a place in one status's list: page on with the `status` the page before answered","schema":{"description":"Open (work still to do), completed, dismissed, or every action; open when omitted, or the named action's own status. A cursor names a place in one status's list: page on with the `status` the page before answered","type":"string","enum":["open","completed","dismissed","all"]}},{"name":"actionId","in":"query","required":false,"description":"Start on the page that holds this action when it matches the filters; ignored with a cursor","schema":{"description":"Start on the page that holds this action when it matches the filters; ignored with a cursor","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"area","in":"query","required":false,"schema":{"type":"string","enum":["product","content","distribution","pricing_packaging","compliance_security","sales_enablement","competitive_positioning","customer_success","operations"]}},{"name":"query","in":"query","required":false,"description":"Matches action titles","schema":{"description":"Matches action titles","type":"string","minLength":1,"maxLength":200}},{"name":"sort","in":"query","required":false,"description":"advisor: Advisor's order, actions awaiting review first and those set aside last (direction does not apply). impact: the lift's modeled annual value where Advisor priced it; unpriced actions tie at zero and keep Advisor's order. completed: when the action was marked done (completedAt); actions not done sort as never","schema":{"default":"impact","description":"advisor: Advisor's order, actions awaiting review first and those set aside last (direction does not apply). impact: the lift's modeled annual value where Advisor priced it; unpriced actions tie at zero and keep Advisor's order. completed: when the action was marked done (completedAt); actions not done sort as never","type":"string","enum":["advisor","impact","area","title","effort","status","age","completed"]}},{"name":"direction","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdvisorActionsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/advisor-actions-v2":{"get":{"operationId":"alpha.advisor-actions.list.v2","summary":"List advisor actions (v2)","description":"Deprecated: use alpha.advisor-actions.list.v3 (alpha_advisor_actions_list_v3), which lists every action on the organization's Advisor list with its section, place, current content revision, value, newest status change and latest outcome. This version answers in the shape it was published with: an action whose content names no live Discovery or Experience campaign is left out; product is the expected effect's (else the campaign's), impact.liftPp the expected effect's estimate (0 without one), priorityScore and reach 0, the evidence arrays empty with evidenceSummary the action's body, latestDecision and outcome null, and review.section new (awaiting review), reviewed (on the published review's list) or set_aside, with no groups. `campaigns` lists the live campaigns that have published, each dispatchId its newest publication. In Advisor's order unless another sort is named; filter by product, campaign, status (open, completed, dismissed, or all), area, or title, or open on the page that holds one action.","deprecated":true,"tags":["alpha"],"x-cli-name":"alpha-advisor-actions-list-v2","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"campaignId","in":"query","required":false,"description":"Only this campaign's actions","schema":{"description":"Only this campaign's actions","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"product","in":"query","required":false,"description":"Only actions of this product","schema":{"description":"Only actions of this product","type":"string","enum":["discovery","experience"]}},{"name":"status","in":"query","required":false,"description":"Open (work still to do), completed, dismissed, or every action; open when omitted, or the named action's own status. A cursor names a place in one status's list: page on with the `status` the page before answered","schema":{"description":"Open (work still to do), completed, dismissed, or every action; open when omitted, or the named action's own status. A cursor names a place in one status's list: page on with the `status` the page before answered","type":"string","enum":["open","completed","dismissed","all"]}},{"name":"actionId","in":"query","required":false,"description":"Start on the page that holds this action when it matches the filters; ignored with a cursor","schema":{"description":"Start on the page that holds this action when it matches the filters; ignored with a cursor","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"area","in":"query","required":false,"schema":{"type":"string","enum":["product","content","distribution","pricing_packaging","compliance_security","sales_enablement","competitive_positioning","customer_success","operations"]}},{"name":"query","in":"query","required":false,"description":"Matches action titles","schema":{"description":"Matches action titles","type":"string","minLength":1,"maxLength":200}},{"name":"sort","in":"query","required":false,"description":"advisor: Advisor's order, actions awaiting review first and those set aside last (direction does not apply). impact: the lift's modeled annual value where Advisor priced it; unpriced actions tie at zero and keep Advisor's order. completed: when the action was marked done (completedAt); actions not done sort as never","schema":{"default":"advisor","description":"advisor: Advisor's order, actions awaiting review first and those set aside last (direction does not apply). impact: the lift's modeled annual value where Advisor priced it; unpriced actions tie at zero and keep Advisor's order. completed: when the action was marked done (completedAt); actions not done sort as never","type":"string","enum":["advisor","impact","area","title","effort","status","age","completed"]}},{"name":"direction","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdvisorActionsListV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/advisor-actions-v3":{"get":{"operationId":"alpha.advisor-actions.list.v3","summary":"List advisor actions (v3)","description":"List the organization's Advisor actions in Advisor's order: open actions the published review has not ordered first (newest first), then its order, then any an older review set aside, then done or dismissed actions it did not place. Each row carries its section and place, the review's one sentence why, its status, its newest status change (who made it, from and to which status, and why: a dismissal's reason, a person's note, or the review's reason for resurfacing, completing, reopening or dropping it), who controls it (automatic: a review may revise or drop it; manual: a person or API key set it, and a review never revises or drops it), its current content revision (title, body, what to do, area, effort, the sites, locations and campaigns it is about, its expected effect and completion criteria), its value where Advisor priced it, its implementation summary as last recorded, its latest measured outcome, and its Ship with Alpha conversation. Filter by status (open by default; completed, dismissed, or all), section, area, the product its live evidence comes from (discovery, experience or inspector; an action whose evidence spans several lists under each, one with none under none), or words in its title, body or action. Also answers the organization's newest review and the published review the order comes from.","tags":["alpha"],"x-cli-name":"alpha-advisor-actions-list-v3","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"status","in":"query","required":false,"description":"Open (work still to do, the default), completed, dismissed, or every action","schema":{"default":"open","description":"Open (work still to do, the default), completed, dismissed, or every action","type":"string","enum":["open","completed","dismissed","all"]}},{"name":"order","in":"query","required":false,"description":"The list's own order (the default), or the newest status change first (e.g. the most recently completed); a cursor pages only the order it came from","schema":{"default":"list","description":"The list's own order (the default), or the newest status change first (e.g. the most recently completed); a cursor pages only the order it came from","type":"string","enum":["list","recent"]}},{"name":"section","in":"query","required":false,"description":"Only this section of the list","schema":{"description":"Only this section of the list","type":"string","enum":["awaiting_review","listed","set_aside"]}},{"name":"area","in":"query","required":false,"schema":{"type":"string","enum":["product","content","distribution","pricing_packaging","compliance_security","sales_enablement","competitive_positioning","customer_success","operations"]}},{"name":"product","in":"query","required":false,"description":"Only actions with live evidence from this product; an action whose evidence spans several products lists under each, and one with none under none","schema":{"description":"Only actions with live evidence from this product; an action whose evidence spans several products lists under each, and one with none under none","type":"string","enum":["discovery","experience","inspector"]}},{"name":"query","in":"query","required":false,"description":"Words in the action's title, body or what to do","schema":{"description":"Words in the action's title, body or what to do","type":"string","minLength":1,"maxLength":200}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdvisorActionsListV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/advisor-actions/{id}":{"get":{"operationId":"alpha.advisor-actions.get.v1","summary":"Get advisor actions","description":"Deprecated: use alpha.advisor-actions.get.v3 (alpha_advisor_actions_get_v3), which reads any action by id with its revisions, events, evidence links and outcomes. This version reads a listed action of a live Discovery campaign in the shape alpha.advisor-actions.list.v1 answers it; any other action is not found. Its history lists the status changes and notes a person, API key, autotracking or a review recorded, oldest first; measuredAt is when its current content was written; frozenRun is null. Once it is shipped with Alpha, also its plan run and the files that run has made.","deprecated":true,"tags":["alpha"],"x-cli-name":"alpha-advisor-actions-get","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"by","in":"query","required":false,"description":"What id names: the action (the default), or the Alpha conversation that ships it with Alpha","schema":{"default":"action","description":"What id names: the action (the default), or the Alpha conversation that ships it with Alpha","type":"string","enum":["action","conversation"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdvisorActionsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/advisor-actions-v2/{id}":{"get":{"operationId":"alpha.advisor-actions.get.v2","summary":"Get advisor actions (v2)","description":"Deprecated: use alpha.advisor-actions.get.v3 (alpha_advisor_actions_get_v3), which reads any action by id with its revisions, events, evidence links and outcomes. This version reads a listed action of a live Discovery or Experience campaign in the shape alpha.advisor-actions.list.v2 answers it; any other action is not found. Its history lists the status changes and notes a person, API key, autotracking or a review recorded, oldest first; measuredAt is when its current content was written; frozenRun is null. Once it is shipped with Alpha, also its plan run and the files that run has made.","deprecated":true,"tags":["alpha"],"x-cli-name":"alpha-advisor-actions-get-v2","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"by","in":"query","required":false,"description":"What id names: the action (the default), or the Alpha conversation that ships it with Alpha","schema":{"default":"action","description":"What id names: the action (the default), or the Alpha conversation that ships it with Alpha","type":"string","enum":["action","conversation"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdvisorActionsGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/advisor-actions-v3/{id}":{"get":{"operationId":"alpha.advisor-actions.get.v3","summary":"Get advisor actions (v3)","description":"Get one Advisor action by id, listed or not (an action an older review retired or merged reads too, with its disposition): its current facts, newest status change and place on the list, every content revision, every event with who made it and why (a person, an API key, automation, the review, or unknown for history carried over from before actors were kept), its evidence links (withdrawn ones included), its implementation summary as last recorded, its stored outcomes (metric and page traffic), and its Ship with Alpha conversation.","tags":["alpha"],"x-cli-name":"alpha-advisor-actions-get-v3","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdvisorActionsGetV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/advisor-actions/create":{"post":{"operationId":"alpha.advisor-actions.create.v1","summary":"Create advisor actions","description":"Deprecated: use alpha.advisor-actions.create.v3 (alpha_advisor_actions_create_v3), which writes an action's whole content without naming a campaign. This version adds the signed-in member's action about a live Discovery campaign: its body is the context and the evidence summary, what to do is its title, and dispatchId is accepted and no longer read. The action lists awaiting Advisor's review at once. No lift is estimated. Needs a signed-in member.","deprecated":true,"tags":["alpha"],"x-cli-name":"alpha-advisor-actions-create","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdvisorActionsCreateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdvisorActionsCreateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/advisor-actions/create-v2":{"post":{"operationId":"alpha.advisor-actions.create.v2","summary":"Create advisor actions (v2)","description":"Deprecated: use alpha.advisor-actions.create.v3 (alpha_advisor_actions_create_v3), which writes an action's whole content without naming a campaign. This version adds the signed-in member's action about a live Discovery or Experience campaign: its body is the context and the evidence summary, what to do is its title, and dispatchId is accepted and no longer read. The action lists awaiting Advisor's review at once. No lift is estimated. Needs a signed-in member.","deprecated":true,"tags":["alpha"],"x-cli-name":"alpha-advisor-actions-create-v2","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdvisorActionsCreateV2Request"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdvisorActionsCreateV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/advisor-actions/create-v3":{"post":{"operationId":"alpha.advisor-actions.create.v3","summary":"Create advisor actions (v3)","description":"Add an action to the organization's Advisor list as the signed-in member: its title, body (why it matters), what to do, area and effort, and optionally the sites, locations and campaigns it is about, the effect it is expected to have, and how to tell it is done. The action is the member's (manual control: autotracking never changes its status until automation is restored) and lists awaiting Advisor's review at once. A repeated Idempotency-Key answers the action its first request created. Needs a signed-in member.","tags":["alpha"],"x-cli-name":"alpha-advisor-actions-create-v3","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdvisorActionsCreateV3Request"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdvisorActionsCreateV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/advisor-actions/update":{"post":{"operationId":"alpha.advisor-actions.update.v1","summary":"Update advisor actions","description":"Deprecated: use alpha.advisor-actions.update.v2 (alpha_advisor_actions_update_v2), which also writes a new content revision and answers every event it recorded. Change an Advisor action's status (open, in progress, completed, or dismissed) or add a note to its history; a dismissal may say why. A person's or API key's status change makes the action theirs, so a review no longer revises or drops it; a note alone does not. applyToGroup is accepted and not read: Advisor no longer groups actions, so `group` is always empty.","deprecated":true,"tags":["alpha"],"x-cli-name":"alpha-advisor-actions-update","x-point11-scope":"alpha:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdvisorActionsUpdateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdvisorActionsUpdateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/advisor-actions/update-v2":{"post":{"operationId":"alpha.advisor-actions.update.v2","summary":"Update advisor actions (v2)","description":"Change an Advisor action as the caller (the member, the operator viewing as them, or the API key, recorded on each event): its status (open, in progress, completed or dismissed; a dismissal may say why, and dismissing again without a reason keeps the one given), a note, or its whole content as a new revision (naming the revision it was edited from; changed since is stale; keeping the subject and expected effect keeps the action's value, changing either unprices it). A status or content revision makes the action the caller's: reviews stop revising or dropping it until automation is restored, though a review may still resurface, complete or reopen it with its reason; a note alone changes neither. Answers the action now, every event it recorded in order (the status change, a note the change could not carry, the change of control) and its content revision; a retried Idempotency-Key writes nothing and answers the same.","tags":["alpha"],"x-cli-name":"alpha-advisor-actions-update-v2","x-point11-scope":"alpha:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdvisorActionsUpdateV2Request"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdvisorActionsUpdateV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/advisor-action-statuses/update":{"post":{"operationId":"alpha.advisor-action-statuses.update.v1","summary":"Update advisor action statuses","description":"Set the status of up to 100 Advisor actions at once as the caller (the member, the operator viewing as them, or the API key, recorded on each event): open, completed, or dismissed, optionally with one reason for every action (one already dismissed keeps its reason when none is given). All or nothing: an id the organization holds no action by changes none of them. Each action moves as alpha_advisor_actions_update_v2 moves one and becomes the caller's (reviews stop revising or dropping it until automation is restored); one already in that status keeps it (changed false once it is the caller's). Answers each action's status and the events recorded; a retried Idempotency-Key writes nothing and answers the same events. alpha_advisor_action_selections_list lists the ids a status filter holds.","tags":["alpha"],"x-cli-name":"alpha-advisor-action-statuses-update","x-point11-scope":"alpha:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdvisorActionStatusesUpdateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdvisorActionStatusesUpdateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/advisor-action-selections":{"get":{"operationId":"alpha.advisor-action-selections.list.v1","summary":"List advisor action selections","description":"List every action alpha_advisor_actions_list_v3 lists under the same status, section, area, product and query, by id alone: each one's id and status, up to 1,000 a page in id order (page with nextCursor). It is what selecting every matching action selects, never its content; read the actions themselves through alpha_advisor_actions_list_v3 or alpha_advisor_actions_get_v3.","tags":["alpha"],"x-cli-name":"alpha-advisor-action-selections-list","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":1000,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"status","in":"query","required":false,"description":"Open (the default), completed, dismissed, or every action","schema":{"default":"open","description":"Open (the default), completed, dismissed, or every action","type":"string","enum":["open","completed","dismissed","all"]}},{"name":"section","in":"query","required":false,"description":"Only this section of the list","schema":{"description":"Only this section of the list","type":"string","enum":["awaiting_review","listed","set_aside"]}},{"name":"area","in":"query","required":false,"schema":{"type":"string","enum":["product","content","distribution","pricing_packaging","compliance_security","sales_enablement","competitive_positioning","customer_success","operations"]}},{"name":"product","in":"query","required":false,"description":"Only actions with live evidence from this product; an action whose evidence spans several products lists under each, and one with none under none","schema":{"description":"Only actions with live evidence from this product; an action whose evidence spans several products lists under each, and one with none under none","type":"string","enum":["discovery","experience","inspector"]}},{"name":"query","in":"query","required":false,"description":"Words in the action's title, body or what to do","schema":{"description":"Words in the action's title, body or what to do","type":"string","minLength":1,"maxLength":200}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdvisorActionSelectionsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/advisor-actions/restore-automation":{"post":{"operationId":"alpha.advisor-actions.restore-automation.v1","summary":"Restore automation advisor actions","description":"Give an Advisor action back to Advisor's review after a person or key set its status or content: a review may revise or drop it again. Recorded in the action's history.","tags":["alpha"],"x-cli-name":"alpha-advisor-actions-restore-automation","x-point11-scope":"alpha:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdvisorActionsRestoreAutomationRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdvisorActionsRestoreAutomationResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/advisor-actions/start-conversation":{"post":{"operationId":"alpha.advisor-actions.start-conversation.v1","summary":"Start conversation advisor actions","description":"Ship an Advisor action with Alpha: open the action's one Alpha conversation, or join the one a teammate already opened; returns its conversation id, where Alpha plans and works the action with the member (alpha_conversations_send asks in it). Needs a signed-in member.","tags":["alpha"],"x-cli-name":"alpha-advisor-actions-start-conversation","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdvisorActionsStartConversationRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdvisorActionsStartConversationResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/advisor-activities/{id}":{"get":{"operationId":"alpha.advisor-activities.get.v1","summary":"Get advisor activities","description":"Read what Advisor is doing now (id \"organization\"): running while its review of the organization's list runs; waiting while a review is owed and not running (it may wait on Billing or on evidence, so it is no promise to start); otherwise next, the instant the next scheduled review is due, in the organization's zone (when it is due, not a promise it runs then). A failed review is read with alpha_advisor_reviews_get_v2. With lastUpdate true it also answers what the published review changed (lastUpdate, null before the first): each action it added or updated with the why it placed it under, and each one it resurfaced (dismissed to open), completed, reopened (completed to open) or dropped (dismissed), with that move's reason, in the order it made them.","tags":["alpha"],"x-cli-name":"alpha-advisor-activities-get","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","const":"organization"}},{"name":"lastUpdate","in":"query","required":false,"description":"Also read what the published review changed (lastUpdate)","schema":{"description":"Also read what the published review changed (lastUpdate)","type":"boolean"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdvisorActivitiesGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/advisor-reviews":{"get":{"operationId":"alpha.advisor-reviews.list.v1","summary":"List advisor reviews","description":"List the organization's Advisor reviews, newest first: each one's run, why it ran (schedule, launch, run_now, or recovery), the failed review it ran again, its state (running, published, failed, or stale: the list changed while it ran, so another review is owed), when it started and settled, its failure code, and the settings and list revisions it read.","tags":["alpha"],"x-cli-name":"alpha-advisor-reviews-list","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdvisorReviewsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/advisor-reviews/{id}":{"get":{"operationId":"alpha.advisor-reviews.get.v1","summary":"Get advisor reviews","description":"Deprecated: use alpha.advisor-reviews.get.v2 (alpha_advisor_reviews_get_v2), which reads any review by id, or the newest, with why it ran, its basis and the publications it read. This version gets the organization's newest Advisor review (id \"organization\"): its run, whether it is running, published or failed (a review that found the list changed while it ran reads as failed, and is not run again: the review it owes runs instead), when it settled, and whether it may be run again (alpha.advisor-reviews.run.v1). Null before the organization's first review. While the newest review failed, Advisor's order stays the last published review's.","deprecated":true,"tags":["alpha"],"x-cli-name":"alpha-advisor-reviews-get","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"\"organization\", Advisor's one org-wide review","schema":{"type":"string","const":"organization","description":"\"organization\", Advisor's one org-wide review"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdvisorReviewsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/advisor-reviews-v2/{id}":{"get":{"operationId":"alpha.advisor-reviews.get.v2","summary":"Get advisor reviews (v2)","description":"Get one Advisor review by its run id; the organization's newest (id \"latest\"; null before its first); or the review whose list is published now, whose order alpha_advisor_actions_list_v3 shows (id \"published\"; null before the first published list). Answers why it ran, the failed review it ran again, its state (running, published, failed, or stale: the list changed while it ran, so another review is owed), when it started and settled, its failure code, the settings and list revisions it read, the publications it read (each campaign's or site's newest measurement when it was admitted, a campaign named by its name as it stands now, null for a site or a campaign since deleted), and whether Run again is offered (alpha_advisor_reviews_run runs it again: only the newest, after it failed). While the newest review failed, Advisor's order stays the last published review's.","tags":["alpha"],"x-cli-name":"alpha-advisor-reviews-get-v2","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"A review's run id; \"latest\" for the organization's newest review; or \"published\" for the review whose list is published now (the order the list shows)","schema":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"string","enum":["latest","published"]}],"description":"A review's run id; \"latest\" for the organization's newest review; or \"published\" for the review whose list is published now (the order the list shows)"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdvisorReviewsGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/advisor-reviews/run":{"post":{"operationId":"alpha.advisor-reviews.run.v1","summary":"Run advisor reviews","description":"Run Advisor now: a free review of the organization's whole list. admitted starts one, whose runId platform_runs_get_v2 follows; owed means a review is running (its runId), so one more runs right after it; refused carries Billing's reason. When the newest review failed this is Run again, and the new review names the one it runs again. A repeated Idempotency-Key answers the review its first request admitted.","tags":["alpha"],"x-cli-name":"alpha-advisor-reviews-run","x-point11-scope":"alpha:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdvisorReviewsRunRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdvisorReviewsRunResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/advisor-reviews/retry":{"post":{"operationId":"alpha.advisor-reviews.retry.v1","summary":"Retry advisor reviews","description":"Deprecated: use alpha.advisor-reviews.run.v1 (alpha_advisor_reviews_run), which runs Advisor whenever it is asked. This version runs the organization's Advisor review again (id \"organization\") only after it failed: admitted runs one new free review, whose runId platform.runs.get follows. Otherwise it answers where the review stands: running (one runs now, its runId), current (the newest review published, its runId), waiting (the newest found the list changed while it ran; the review it owes runs shortly), nothing_to_review (no review has run yet), or refused (with Billing's reason). A review no longer waits for campaigns' measurements, so waiting never means one is still settling.","deprecated":true,"tags":["alpha"],"x-cli-name":"alpha-advisor-reviews-retry","x-point11-scope":"alpha:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdvisorReviewsRetryRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdvisorReviewsRetryResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/advisor-settings-v2/{id}":{"get":{"operationId":"alpha.advisor-settings.get.v2","summary":"Get advisor settings (v2)","description":"Deprecated: use alpha.advisor-settings.get.v5 (alpha_advisor_settings_get_v5), which answers the list size and who saved each revision. This version names the priorities `steering`, answers implementationTrackingEnabled true in either recorded autotracking mode (nothing acts on autotracking any more: Advisor's review checks the site itself), and reads a value equal to the product default as the product's (not stored). Get Advisor's organization-wide settings (id \"organization\"): how often recommendations refresh, the steering guidance, and implementation tracking, each with the layer it comes from (organization or product default) and what the organization itself stores.","deprecated":true,"tags":["alpha"],"x-cli-name":"alpha-advisor-settings-get-v2","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"\"organization\", Advisor's one org-wide scope","schema":{"type":"string","const":"organization","description":"\"organization\", Advisor's one org-wide scope"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdvisorSettingsGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/advisor-settings-v3/{id}":{"get":{"operationId":"alpha.advisor-settings.get.v3","summary":"Get advisor settings (v3)","description":"Deprecated: use alpha.advisor-settings.get.v5 (alpha_advisor_settings_get_v5), which answers the list size and who saved each revision. This version answers implementationTrackingEnabled true in either recorded autotracking mode (nothing acts on autotracking any more: Advisor's review checks the site itself) and reads a value equal to the product default as the product's (not stored). Get Advisor's organization-wide settings (id \"organization\"), which every campaign of every product runs with: how often recommendations refresh, the priorities Advisor weighs, and implementation tracking, each with the layer it comes from (organization or product default) and what the organization itself stores.","deprecated":true,"tags":["alpha"],"x-cli-name":"alpha-advisor-settings-get-v3","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"\"organization\", Advisor's one org-wide scope","schema":{"type":"string","const":"organization","description":"\"organization\", Advisor's one org-wide scope"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdvisorSettingsGetV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/advisor-settings-v4/{id}":{"get":{"operationId":"alpha.advisor-settings.get.v4","summary":"Get advisor settings (v4)","description":"Deprecated: use alpha.advisor-settings.get.v5 (alpha_advisor_settings_get_v5), which leaves out autotracking. This version also answers autotracking's recorded mode (off, suggest or complete) in the current revision and each one of its history, which nothing acts on any more: Advisor's review checks the site itself. Get Advisor's organization-wide settings (id \"organization\"), which every campaign of every product runs with: when Advisor reviews the list (monthly or weekly), the priorities it weighs, autotracking, and listSize, the most open actions each review keeps on the list (3, 5, 10, 15 or 20), as the current revision with who saved it and when, and the newest 50 revisions as history, newest first. Revision 0 is the product defaults (monthly, no priorities, autotracking off, 5 actions), before the organization's first save.","deprecated":true,"tags":["alpha"],"x-cli-name":"alpha-advisor-settings-get-v4","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"\"organization\", Advisor's one org-wide scope","schema":{"type":"string","const":"organization","description":"\"organization\", Advisor's one org-wide scope"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdvisorSettingsGetV4Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/advisor-settings-v5/{id}":{"get":{"operationId":"alpha.advisor-settings.get.v5","summary":"Get advisor settings (v5)","description":"Get Advisor's organization-wide settings (id \"organization\"), which every campaign of every product runs with: when Advisor reviews the list (monthly or weekly), the priorities it weighs, and listSize, the most open actions each review keeps on the list (3, 5, 10, 15 or 20), as the current revision with who saved it and when, and the newest 50 revisions as history, newest first. Revision 0 is the product defaults (monthly, no priorities, 5 actions), before the organization's first save.","tags":["alpha"],"x-cli-name":"alpha-advisor-settings-get-v5","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"\"organization\", Advisor's one org-wide scope","schema":{"type":"string","const":"organization","description":"\"organization\", Advisor's one org-wide scope"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdvisorSettingsGetV5Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/advisor-settings/update-v2":{"post":{"operationId":"alpha.advisor-settings.update.v2","summary":"Update advisor settings (v2)","description":"Deprecated: use alpha.advisor-settings.update.v5 (alpha_advisor_settings_update_v5), which changes only the fields it names. This version names the priorities `steering` and replaces the organization's settings (id \"organization\"), which every campaign runs with: a field present sets it (null is an explicit none), a field absent returns to the product default. implementationTrackingEnabled true keeps autotracking's recorded mode while it is on and otherwise records it on as suggest; false, or absent, records it off. Nothing acts on autotracking any more: Advisor's review checks the site itself. Each save is one revision recorded as the signed-in member's. The refresh interval changes which already-funded analyses also refresh recommendations, never what is charged. Needs a signed-in member.","deprecated":true,"tags":["alpha"],"x-cli-name":"alpha-advisor-settings-update-v2","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdvisorSettingsUpdateV2Request"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdvisorSettingsUpdateV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/advisor-settings/update-v3":{"post":{"operationId":"alpha.advisor-settings.update.v3","summary":"Update advisor settings (v3)","description":"Deprecated: use alpha.advisor-settings.update.v5 (alpha_advisor_settings_update_v5), which changes only the fields it names. This version replaces the organization's Advisor settings (id \"organization\"), which every campaign of every product runs with: a field present sets it (null is an explicit none), a field absent returns to the product default. implementationTrackingEnabled true keeps autotracking's recorded mode while it is on and otherwise records it on as suggest; false, or absent, records it off. Nothing acts on autotracking any more: Advisor's review checks the site itself. Each save is one revision recorded as the signed-in member's. Changed priorities make Advisor's next review due at once: it runs at the next hourly dispatch, or when a review already running finishes; the refresh interval changes which already-funded analyses also refresh recommendations, never what is charged. Needs a signed-in member.","deprecated":true,"tags":["alpha"],"x-cli-name":"alpha-advisor-settings-update-v3","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdvisorSettingsUpdateV3Request"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdvisorSettingsUpdateV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/advisor-settings/update-v4":{"post":{"operationId":"alpha.advisor-settings.update.v4","summary":"Update advisor settings (v4)","description":"Deprecated: use alpha.advisor-settings.update.v5 (alpha_advisor_settings_update_v5), which leaves out autotracking. This version also records implementationTracking (off, suggest or complete) when present and answers it, which nothing acts on any more: Advisor's review checks the site itself. Change the organization's Advisor settings (id \"organization\"), which every campaign of every product runs with: each field present sets it (priorities null or empty is none), each field absent keeps its current value. Every save is one revision recording the signed-in member who saved it; the answer is that revision, and a repeated Idempotency-Key answers the revision its first request saved and writes nothing. Changed priorities or listSize make Advisor's next review due at once: it runs at the next hourly dispatch, or when a review already running finishes; a new refresh interval moves Advisor's review onto its periods (each UTC month from the 1st, or each UTC week from Monday). Needs a signed-in member.","deprecated":true,"tags":["alpha"],"x-cli-name":"alpha-advisor-settings-update-v4","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdvisorSettingsUpdateV4Request"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdvisorSettingsUpdateV4Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/advisor-settings/update-v5":{"post":{"operationId":"alpha.advisor-settings.update.v5","summary":"Update advisor settings (v5)","description":"Change the organization's Advisor settings (id \"organization\"), which every campaign of every product runs with: each field present sets it (priorities null or empty is none), each field absent keeps its current value. Every save is one revision recording the signed-in member who saved it; the answer is that revision, and a repeated Idempotency-Key answers the revision its first request saved and writes nothing. Changed priorities or listSize make Advisor's next review due at once: it runs at the next hourly dispatch, or when a review already running finishes; a new refresh interval moves Advisor's review onto its periods (each UTC month from the 1st, or each UTC week from Monday). Needs a signed-in member.","tags":["alpha"],"x-cli-name":"alpha-advisor-settings-update-v5","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdvisorSettingsUpdateV5Request"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAdvisorSettingsUpdateV5Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/win-customer-projects":{"get":{"operationId":"alpha.win-customer-projects.list.v1","summary":"List win customer projects","description":"List the Win This Customer projects the caller may open, newest first, with each one's customer, title, and how many of its plan's steps are done. A project lists where its Alpha conversation can be read: the caller's own, one shared with them by name, or one every member reads; an API key lists only projects whose conversation it started.","tags":["alpha"],"x-cli-name":"alpha-win-customer-projects-list","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaWinCustomerProjectsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/win-customer-projects/{id}":{"get":{"operationId":"alpha.win-customer-projects.get.v1","summary":"Get win customer projects","description":"Get one Win This Customer project the caller may open: its frozen customer sources and its Alpha conversation, where Alpha plans and works the win-back with the member. A project whose conversation the caller cannot read is not found.","tags":["alpha"],"x-cli-name":"alpha-win-customer-projects-get","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaWinCustomerProjectsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/win-customer-projects/create":{"post":{"operationId":"alpha.win-customer-projects.create.v1","summary":"Create win customer projects","description":"Open a Win This Customer project for a saved customer or an Experience run; a retry with the same idempotency key returns the same project. Needs a signed-in member.","tags":["alpha"],"x-cli-name":"alpha-win-customer-projects-create","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaWinCustomerProjectsCreateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaWinCustomerProjectsCreateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/customer-cases/create":{"post":{"operationId":"alpha.customer-cases.create.v1","summary":"Create customer cases","description":"Open a customer case: a new Alpha conversation beside a customer surface, bound to what it works. kind customer_edit is Bulk edit's chat over the selected customers (customerIds: any number of any of the organization's business profiles, each once, in the grid's order; no businessProfileId), held by id; its turns read the customers through Business's operations as the member and propose changes only through business_customer_edit_reviews_create_v5. kind customer_describe is Describe's chat about count new customers of one business profile (no customerIds); its turns read the group they describe only through business_customer_descriptions_create_v3. Returns the case and its conversation: send its turns with alpha_conversations_send (threadId is conversationId). Its turns never save or add a customer and are included, drawing no Alpha credits; the conversation is left out of alpha_conversations_list, and alpha_customer_cases_get names the review or description it last requested. A retry with the same idempotency key returns the same case. Needs a signed-in member.","tags":["alpha"],"x-cli-name":"alpha-customer-cases-create","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaCustomerCasesCreateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaCustomerCasesCreateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/customer-cases/{id}":{"get":{"operationId":"alpha.customer-cases.get.v1","summary":"Get customer cases","description":"Get a customer case the signed-in member opened (alpha_customer_cases_create): its conversation, kind, a describe case's business profile (null for a customer edit), how many customers a customer edit's selection holds or a describe case describes (count), every review its most recent reviewing turn requested (latestReviewRunIds, in request order, each a run business_customer_edit_reviews_get_v2 follows, and that turn, latestReviewTurnId; empty and null before the first), and the newest description its turns requested (latestDescriptionId, which business_customer_descriptions_get reads; null before the first). Needs a signed-in member.","tags":["alpha"],"x-cli-name":"alpha-customer-cases-get","x-point11-scope":"alpha:read","security":[{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The case's caseId","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The case's caseId"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaCustomerCasesGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/customer-cases/update":{"post":{"operationId":"alpha.customer-cases.update.v1","summary":"Update customer cases","description":"Set how many new customers a describe case the signed-in member opened (alpha_customer_cases_create, kind customer_describe) describes, when its surface's count changes: the case's next turn reads the new count; earlier turns and descriptions keep theirs. A customer edit's case, another member's or another tenant's is not found. Needs a signed-in member.","tags":["alpha"],"x-cli-name":"alpha-customer-cases-update","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaCustomerCasesUpdateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaCustomerCasesUpdateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/activities/{id}":{"get":{"operationId":"alpha.activities.get.v1","summary":"Get activities","description":"Read what Alpha is doing for you now (id \"organization\"): your own answers running in Alpha conversations (one admitted and about to run counts as running; never a teammate's, never a Studio round's or a customer case's), the organization's Alpha workflow and Brand Kit runs, and when the next scheduled Alpha report is due. reading is running (with how many: your answers, workflow runs that started and Brand Kit runs whose model attempt runs); otherwise waiting (with how many: workflow runs not yet started and Brand Kit runs waiting with no attempt running; they may be blocked, so it is no promise to start); otherwise next (the report's due instant and the organization's zone: when it is due, not a promise it runs then); otherwise idle. subject names the one conversation when exactly one of your answers runs and no run does.","tags":["alpha"],"x-cli-name":"alpha-activities-get","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","const":"organization"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaActivitiesGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/conversations":{"get":{"operationId":"alpha.conversations.list.v1","summary":"List conversations","description":"List the signed-in member's own Alpha conversations, most recently active first, optionally whose title contains query. Needs a signed-in member.","tags":["alpha"],"x-cli-name":"alpha-conversations-list","x-point11-scope":"alpha:read","security":[{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"query","in":"query","required":false,"schema":{"type":"string","maxLength":200}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaConversationsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/projects":{"get":{"operationId":"alpha.projects.list.v1","summary":"List projects","description":"List the Alpha projects the signed-in member can open: their own and those shared with the organization. Needs a signed-in member.","tags":["alpha"],"x-cli-name":"alpha-projects-list","x-point11-scope":"alpha:read","security":[{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"conversationId","in":"query","required":false,"description":"A chat whose project to name in currentProjectId","schema":{"description":"A chat whose project to name in currentProjectId","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"query","in":"query","required":false,"description":"Name text to match anywhere, as typed; a cursor continues one query","schema":{"description":"Name text to match anywhere, as typed; a cursor continues one query","type":"string","maxLength":80}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaProjectsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/projects/{id}":{"get":{"operationId":"alpha.projects.get.v1","summary":"Get projects","description":"Get one Alpha project the signed-in member can open, with its conversations. Needs a signed-in member.","tags":["alpha"],"x-cli-name":"alpha-projects-get","x-point11-scope":"alpha:read","security":[{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaProjectsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/files":{"get":{"operationId":"alpha.files.list.v1","summary":"List files","description":"List the files, pages, and media Alpha made in every conversation the member may read (their own, and teammates' conversations in shared projects), newest first, optionally by title text and kind. An API key lists only those from conversations it started.","tags":["alpha"],"x-cli-name":"alpha-files-list","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"query","in":"query","required":false,"description":"Title text to match anywhere, as typed; a cursor continues one query","schema":{"description":"Title text to match anywhere, as typed; a cursor continues one query","type":"string","maxLength":120}},{"name":"kind","in":"query","required":false,"description":"Only files of this kind","schema":{"description":"Only files of this kind","type":"string","enum":["markdown","slides","image","audio","video","brand_kit","presentation","spreadsheet","word","pdf","csv","page"]}},{"name":"includeWorking","in":"query","required":false,"description":"Also list working files, which turns make on the way (a CSV handed to a build, a scratch check); a cursor continues one choice","schema":{"default":false,"description":"Also list working files, which turns make on the way (a CSV handed to a build, a scratch check); a cursor continues one choice","type":"boolean"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaFilesListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/connectors":{"get":{"operationId":"alpha.connectors.list.v1","summary":"List connectors","description":"List the tools Alpha Chat can connect to (for example Linear or Google Drive), each with whether the signed-in member has connected it and the account it reports. Connections are the member's own, so a member viewed by an operator lists none. Needs a signed-in member.","tags":["alpha"],"x-cli-name":"alpha-connectors-list","x-point11-scope":"alpha:read","security":[{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaConnectorsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/connector-files":{"get":{"operationId":"alpha.connector-files.list.v1","summary":"List connector files","description":"Browse one of the member's own connected apps for a file to bring into a test: Google Drive, OneDrive or Dropbox (a folder by its ref as container, the top when omitted, or a search by query), a Figma file's frames (its link or key as container), or Canva designs (newest first, or a search by query). Each item is a file, or a folder to open by its ref; follow nextCursor with the same container and query. Bring a file in with research_study_attachments_import_connected. Reads with the member's own connection, so connect the app in Settings, under Connections, first; an operator viewing as the member reads none.","tags":["alpha"],"x-cli-name":"alpha-connector-files-list","x-point11-scope":"alpha:read","security":[{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"service","in":"query","required":true,"description":"The connected app: google (Google Drive), microsoft (OneDrive), dropbox, figma or canva.","schema":{"type":"string","enum":["google","microsoft","dropbox","figma","canva"],"description":"The connected app: google (Google Drive), microsoft (OneDrive), dropbox, figma or canva."}},{"name":"container","in":"query","required":false,"description":"A folder's ref from an earlier page, or a Figma file's link or key; the app's top when omitted.","schema":{"description":"A folder's ref from an earlier page, or a Figma file's link or key; the app's top when omitted.","type":"string","minLength":1,"maxLength":2048}},{"name":"query","in":"query","required":false,"description":"Search by name.","schema":{"description":"Search by name.","type":"string","minLength":1,"maxLength":500}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaConnectorFilesListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/connector-permissions/{id}":{"get":{"operationId":"alpha.connector-permissions.get.v1","summary":"Get connector permissions","description":"Get what Alpha may do with one connector (id is its service key, such as linear): the actions the service lists right now, read with the signed-in member's own connection, each with its permission (asks first, allowed, declined, blocked, or off) and who decided it, plus whether an admin switched the connector off. Needs a signed-in member.","tags":["alpha"],"x-cli-name":"alpha-connector-permissions-get","x-point11-scope":"alpha:read","security":[{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The connector's service key, such as linear","schema":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,39}$","description":"The connector's service key, such as linear"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaConnectorPermissionsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/connector-permissions/update":{"post":{"operationId":"alpha.connector-permissions.update.v1","summary":"Update connector permissions","description":"Set a connector for everyone in the organization: switch it on or off, and set any of its actions to Allow for everyone (only an action Point11 lists as a read: on any other it is refused 409 CONNECTOR_CHOICE_NOT_OFFERED), Ask every time, or Blocked, or clear those overrides. Needs an admin.","tags":["alpha"],"x-cli-name":"alpha-connector-permissions-update","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaConnectorPermissionsUpdateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaConnectorPermissionsUpdateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/connector-choices/update":{"post":{"operationId":"alpha.connector-choices.update.v1","summary":"Update connector choices","description":"Set the signed-in member's own choices for a connector's actions: Always allow, Don't allow, or reset to asking the first time. An admin's override still wins, and a change Always allowed still asks in a chat that has read what someone else wrote. Needs a signed-in member.","tags":["alpha"],"x-cli-name":"alpha-connector-choices-update","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaConnectorChoicesUpdateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaConnectorChoicesUpdateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/connector-approvals/decide":{"post":{"operationId":"alpha.connector-approvals.decide.v1","summary":"Decide connector approvals","description":"Answer the connector card on one of the member's own Alpha answers: Always allow, Approve once, or Don't allow a call Alpha asked to make; an admin may approve one blocked call once or unblock it. Re-checks the current permission, saves choices, and returns the next question to send in that conversation, in which Alpha makes the approved call. Needs a signed-in member.","tags":["alpha"],"x-cli-name":"alpha-connector-approvals-decide","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaConnectorApprovalsDecideRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaConnectorApprovalsDecideResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/connector-access-requests/create":{"post":{"operationId":"alpha.connector-access-requests.create.v1","summary":"Create connector access requests","description":"Ask the organization's admins to unblock a connector action (or switch on a connector) that the card on one of the member's own Alpha answers says is blocked; the admins are emailed. One open request per member and action. Needs a signed-in member.","tags":["alpha"],"x-cli-name":"alpha-connector-access-requests-create","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaConnectorAccessRequestsCreateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaConnectorAccessRequestsCreateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/connector-access-requests":{"get":{"operationId":"alpha.connector-access-requests.list.v1","summary":"List connector access requests","description":"List the organization's requests to unblock connector actions, newest first, open ones unless status says otherwise, optionally for one connector. Needs an admin.","tags":["alpha"],"x-cli-name":"alpha-connector-access-requests-list","x-point11-scope":"alpha:read","security":[{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"service","in":"query","required":false,"description":"The connector's service key, such as linear","schema":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,39}$","description":"The connector's service key, such as linear"}},{"name":"status","in":"query","required":false,"description":"Which requests to list; open ones by default","schema":{"default":"open","description":"Which requests to list; open ones by default","type":"string","enum":["open","unblocked","declined"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaConnectorAccessRequestsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/connector-access-requests/decide":{"post":{"operationId":"alpha.connector-access-requests.decide.v1","summary":"Decide connector access requests","description":"Answer one open connector access request: unblock clears the block for everyone (or switches the connector on) and emails the requester a link back to their conversation; decline closes it. Needs an admin.","tags":["alpha"],"x-cli-name":"alpha-connector-access-requests-decide","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaConnectorAccessRequestsDecideRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaConnectorAccessRequestsDecideResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/chat-options/{id}":{"get":{"operationId":"alpha.chat-options.get.v1","summary":"Get chat options","description":"Get what the member's Alpha Chat composer offers (id \"organization\"): the managed model, the Brand Kit revision a question without a brand choice uses, the member's own tool connections, the kinds of work Alpha can create here, and the first open Advisor actions a new chat can start from. A part that cannot be read right now is null.","tags":["alpha"],"x-cli-name":"alpha-chat-options-get","x-point11-scope":"alpha:read","security":[{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Always \"organization\": the caller's own","schema":{"type":"string","const":"organization","description":"Always \"organization\": the caller's own"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaChatOptionsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/transcriptions/create":{"post":{"operationId":"alpha.transcriptions.create.v1","summary":"Create transcriptions","description":"Transcribe a short spoken recording to text, for example to use as a question in alpha_conversations_send: audio is the recording's bytes as base64, at most 3 MiB (3,145,728 bytes) once decoded, in audio/webm, audio/mp4 or audio/wav. Nothing is stored and each call transcribes again; calls are rate limited per credential.","tags":["alpha"],"x-cli-name":"alpha-transcriptions-create","x-point11-scope":"alpha:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaTranscriptionsCreateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaTranscriptionsCreateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/conversations/{id}":{"get":{"operationId":"alpha.conversations.get.v1","summary":"Get conversations","description":"Deprecated: use alpha.conversations.get.v4 (alpha_conversations_get_v4), which reads the conversation and never streams, lists the plan's versions without their bodies, and opens on a shorter first page; follow a running answer with alpha.turn-events.get.v1 (alpha_turn_events_get), whose last event carries what the answer became. Get one Alpha conversation the member may read: its newest page of messages (pass beforeMessageIndex from nextBeforeMessageIndex for older ones), how it is shared with them, and every version of its plan with its body. While its newest answer is still running, a call with Accept: text/event-stream (REST) or an MCP progress token follows that answer's events and ends with this result; with nothing running it returns at once. A reader following again passes the provisional text it already drew (resumeSegment, resumeOffset) and is not sent it again. An API key reads only the conversations it started. Answered in the values it was published with: a question's PowerPoint attachment is left out of its attachments and file parts, and an edit_file call reads as create_file, its label saying it edited. Media-edit evidence calls are omitted; their resulting artifacts stay visible.","deprecated":true,"tags":["alpha"],"x-cli-name":"alpha-conversations-get","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Alpha conversation ID","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Alpha conversation ID"}},{"name":"beforeMessageIndex","in":"query","required":false,"description":"Read the page of messages before this index (the previous nextBeforeMessageIndex)","schema":{"description":"Read the page of messages before this index (the previous nextBeforeMessageIndex)","type":"integer","minimum":0,"maximum":9007199254740991}},{"name":"resumeSegment","in":"query","required":false,"description":"Following again: the provisional text this reader already drew, named by its text-start id after `provisional:`; that segment's text before resumeOffset, and every earlier segment, are not sent again","schema":{"description":"Following again: the provisional text this reader already drew, named by its text-start id after `provisional:`; that segment's text before resumeOffset, and every earlier segment, are not sent again","type":"string","minLength":1,"maxLength":128}},{"name":"resumeOffset","in":"query","required":false,"description":"How much of resumeSegment's text this reader drew, in UTF-16 units (default 0)","schema":{"description":"How much of resumeSegment's text this reader drew, in UTF-16 units (default 0)","type":"integer","minimum":0,"maximum":9007199254740991}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success. With `Accept: text/event-stream`, the live events as server-sent events: one `progress` event per live event, then exactly one `result` (the output) or `error` (`OperationError`). A refusal before the first event is the ordinary JSON error.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaConversationsGetResponse"}},"text/event-stream":{"schema":{"description":"One server-sent event.","oneOf":[{"type":"object","required":["event","data"],"properties":{"event":{"const":"progress"},"data":{"$ref":"#/components/schemas/AlphaConversationsGetEvent"}}},{"type":"object","required":["event","data"],"properties":{"event":{"const":"result"},"data":{"$ref":"#/components/schemas/AlphaConversationsGetResponse"}}},{"type":"object","required":["event","data"],"properties":{"event":{"const":"error"},"data":{"$ref":"#/components/schemas/OperationError"}}}]}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/conversations-v2/{id}":{"get":{"operationId":"alpha.conversations.get.v2","summary":"Get conversations (v2)","description":"Deprecated: use alpha.conversations.get.v4 (alpha_conversations_get_v4), which reads the conversation and never streams, lists the plan's versions without their bodies, and opens on a shorter first page; follow a running answer with alpha.turn-events.get.v1 (alpha_turn_events_get), whose last event carries what the answer became. Get one Alpha conversation the member may read: its newest page of messages (pass beforeMessageIndex from nextBeforeMessageIndex for older ones), how it is shared with them, and every version of its plan with its body. While its newest answer is still running, a call with Accept: text/event-stream (REST) or an MCP progress token follows that answer's events and ends with this result; with nothing running it returns at once. A reader following again passes the provisional text it already drew (resumeSegment, resumeOffset) and is not sent it again. An API key reads only the conversations it started. Names its published attachment formats and creative verbs, PowerPoint attachments and edit_file included. Media-edit evidence calls are omitted; their resulting artifacts stay visible.","deprecated":true,"tags":["alpha"],"x-cli-name":"alpha-conversations-get-v2","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Alpha conversation ID","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Alpha conversation ID"}},{"name":"beforeMessageIndex","in":"query","required":false,"description":"Read the page of messages before this index (the previous nextBeforeMessageIndex)","schema":{"description":"Read the page of messages before this index (the previous nextBeforeMessageIndex)","type":"integer","minimum":0,"maximum":9007199254740991}},{"name":"resumeSegment","in":"query","required":false,"description":"Following again: the provisional text this reader already drew, named by its text-start id after `provisional:`; that segment's text before resumeOffset, and every earlier segment, are not sent again","schema":{"description":"Following again: the provisional text this reader already drew, named by its text-start id after `provisional:`; that segment's text before resumeOffset, and every earlier segment, are not sent again","type":"string","minLength":1,"maxLength":128}},{"name":"resumeOffset","in":"query","required":false,"description":"How much of resumeSegment's text this reader drew, in UTF-16 units (default 0)","schema":{"description":"How much of resumeSegment's text this reader drew, in UTF-16 units (default 0)","type":"integer","minimum":0,"maximum":9007199254740991}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success. With `Accept: text/event-stream`, the live events as server-sent events: one `progress` event per live event, then exactly one `result` (the output) or `error` (`OperationError`). A refusal before the first event is the ordinary JSON error.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaConversationsGetV2Response"}},"text/event-stream":{"schema":{"description":"One server-sent event.","oneOf":[{"type":"object","required":["event","data"],"properties":{"event":{"const":"progress"},"data":{"$ref":"#/components/schemas/AlphaConversationsGetV2Event"}}},{"type":"object","required":["event","data"],"properties":{"event":{"const":"result"},"data":{"$ref":"#/components/schemas/AlphaConversationsGetV2Response"}}},{"type":"object","required":["event","data"],"properties":{"event":{"const":"error"},"data":{"$ref":"#/components/schemas/OperationError"}}}]}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/conversations-v3/{id}":{"get":{"operationId":"alpha.conversations.get.v3","summary":"Get conversations (v3)","description":"Deprecated: use alpha.conversations.get.v4 (alpha_conversations_get_v4), which also names edit_media evidence. Media-edit evidence calls are omitted here; their resulting artifacts stay visible. Get one Alpha conversation the member may read: its newest page of messages (the newest six questions; pass beforeMessageIndex from nextBeforeMessageIndex for older ones, twenty questions a page), how it is shared with them, the case it works, and its plan. The plan is its newest version with its body (plan), that version's steps as a running record over every version before it (planTrack), and every version listed without its body (planVersions); read an earlier version with alpha_conversation_plans_get. The read never streams: while an answer is still running its message says so, and alpha_turn_events_get follows it by its turn id. An API key reads only the conversations it started.","deprecated":true,"tags":["alpha"],"x-cli-name":"alpha-conversations-get-v3","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Alpha conversation ID","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Alpha conversation ID"}},{"name":"beforeMessageIndex","in":"query","required":false,"description":"Read the page of messages before this index (the previous nextBeforeMessageIndex)","schema":{"description":"Read the page of messages before this index (the previous nextBeforeMessageIndex)","type":"integer","minimum":0,"maximum":9007199254740991}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaConversationsGetV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/conversations-v4/{id}":{"get":{"operationId":"alpha.conversations.get.v4","summary":"Get conversations (v4)","description":"Get one Alpha conversation the member may read: its newest page of messages (the newest six questions; pass beforeMessageIndex from nextBeforeMessageIndex for older ones, twenty questions a page), how it is shared with them, the case it works, and its plan. The plan is its newest version with its body (plan), that version's steps as a running record over every version before it (planTrack), and every version listed without its body (planVersions); read an earlier version with alpha_conversation_plans_get. The read never streams: while an answer is still running its message says so, and alpha_turn_events_get follows it by its turn id. An API key reads only the conversations it started.","tags":["alpha"],"x-cli-name":"alpha-conversations-get-v4","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Alpha conversation ID","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Alpha conversation ID"}},{"name":"beforeMessageIndex","in":"query","required":false,"description":"Read the page of messages before this index (the previous nextBeforeMessageIndex)","schema":{"description":"Read the page of messages before this index (the previous nextBeforeMessageIndex)","type":"integer","minimum":0,"maximum":9007199254740991}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaConversationsGetV4Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/conversation-plans/{id}":{"get":{"operationId":"alpha.conversation-plans.get.v1","summary":"Get conversation plans","description":"Get one version of the plan Alpha keeps in a conversation the member may read, by the conversation's id and the version's revision (a planVersions entry of alpha_conversations_get_v4, or the revision a running answer's plan-revision event names): the version with its body, and its steps as a running record over every version before it (the first plan's steps in their order, each where this version says it stands, with a log of what each version changed). An API key reads only the conversations it started.","tags":["alpha"],"x-cli-name":"alpha-conversation-plans-get","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Alpha conversation ID","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Alpha conversation ID"}},{"name":"revision","in":"query","required":true,"description":"The version's revision, as a planVersions entry names it","schema":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"The version's revision, as a planVersions entry names it"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaConversationPlansGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/conversations/send":{"post":{"operationId":"alpha.conversations.send.v1","summary":"Send conversations","description":"Ask Alpha a question in a conversation on the organization's Alpha credits; a new conversation id starts one. The idempotency key is the turn id: a retry returns the same turn. With Accept: text/event-stream (REST) or an MCP progress token it streams the turn's events, ending with the result; otherwise follow turnId with alpha_turn_events_get (whose last event is the answer), or poll runId with platform_runs_get_v2, then read alpha_conversations_get_v4; alpha_files_list lists what it made. The member's connected tools join where they wrote everything in the conversation, elsewhere only with useConnectors; if someone else writes there while a question without it is admitted, it is refused 409 PRECONDITION_FAILED (connectors_unconfirmed), nothing reserved, and goes without them when sent again. An API key asks as its creator, only in a conversation it started, without connected tools.","tags":["alpha"],"x-cli-name":"alpha-conversations-send","x-point11-scope":"alpha:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaConversationsSendRequest"}}}},"responses":{"200":{"description":"The run's live events. With `Accept: text/event-stream`, the live events as server-sent events: one `progress` event per live event, then exactly one `result` (the output) or `error` (`OperationError`). A refusal before the first event is the ordinary JSON error.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"text/event-stream":{"schema":{"description":"One server-sent event.","oneOf":[{"type":"object","required":["event","data"],"properties":{"event":{"const":"progress"},"data":{"$ref":"#/components/schemas/AlphaConversationsSendEvent"}}},{"type":"object","required":["event","data"],"properties":{"event":{"const":"result"},"data":{"$ref":"#/components/schemas/AlphaConversationsSendResponse"}}},{"type":"object","required":["event","data"],"properties":{"event":{"const":"error"},"data":{"$ref":"#/components/schemas/OperationError"}}}]}}}},"202":{"description":"Accepted: the durable run started. Follow it with `GET /api/v1/platform/runs-v2/{id}`.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaConversationsSendResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/conversations/update":{"post":{"operationId":"alpha.conversations.update.v1","summary":"Update conversations","description":"Rename one of the member's own Alpha conversations (title), or move it into one of their projects (projectId; null takes it out). One change per call, so each call is all or nothing.","tags":["alpha"],"x-cli-name":"alpha-conversations-update","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaConversationsUpdateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaConversationsUpdateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/conversations/delete":{"post":{"operationId":"alpha.conversations.delete.v1","summary":"Delete conversations","description":"Delete one of the member's own Alpha conversations; any page published from it stops answering. This cannot be undone, so ask the user first.","tags":["alpha"],"x-cli-name":"alpha-conversations-delete","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaConversationsDeleteRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaConversationsDeleteResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/conversations/clear":{"post":{"operationId":"alpha.conversations.clear.v1","summary":"Clear conversations","description":"Delete every Alpha conversation the member has in this organization and return how many were deleted. This cannot be undone, so ask the user first.","tags":["alpha"],"x-cli-name":"alpha-conversations-clear","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaConversationsClearRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaConversationsClearResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/turns/cancel":{"post":{"operationId":"alpha.turns.cancel.v1","summary":"Cancel turns","description":"Ask a running Alpha answer to stop, by its turn id; an answer that already finished reports already_terminal. The turn ends as cancelled once its work stops.","tags":["alpha"],"x-cli-name":"alpha-turns-cancel","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaTurnsCancelRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaTurnsCancelResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/turn-activity/{id}":{"get":{"operationId":"alpha.turn-activity.get.v1","summary":"Get turn activity","description":"Get the member's own Alpha answers still running in this organization (id \"organization\"), newest first: each one's conversation, turn, the conversation's title, when it was asked, and where it opens (chat, or studio for a Studio project's round), with a revision that changes whenever one of them starts or settles. A teammate's answer, even in a conversation shared with the member, is never listed.","tags":["alpha"],"x-cli-name":"alpha-turn-activity-get","x-point11-scope":"alpha:read","security":[{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Always \"organization\".","schema":{"type":"string","const":"organization","description":"Always \"organization\"."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaTurnActivityGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/turn-events/{id}":{"get":{"operationId":"alpha.turn-events.get.v1","summary":"Get turn events","description":"Get where one Alpha answer stands, by its turn id (the turnId alpha_conversations_send returned): whether it is still running, and the index to follow it from. With Accept: text/event-stream (REST) or an MCP progress token, the call follows the answer while it runs: each event names the index it was stored under and carries AI SDK UI message chunks for the answer's message, and the last event carries settled, what the answer became (that question's messages exactly as alpha_conversations_get_v4 returns them), so nothing is read again. A reader that comes back passes startIndex, the index after the last event it drew, and is sent only what follows. An answer that already finished is an opening event and then the settled one. An API key follows only answers in conversations it started.","tags":["alpha"],"x-cli-name":"alpha-turn-events-get","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Alpha turn ID","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Alpha turn ID"}},{"name":"startIndex","in":"query","required":false,"description":"Following again: the index after the last event this reader drew (the previous nextIndex); events before it are not sent again. Omit to follow from the turn's first event","schema":{"description":"Following again: the index after the last event this reader drew (the previous nextIndex); events before it are not sent again. Omit to follow from the turn's first event","type":"integer","minimum":0,"maximum":9007199254740991}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success. With `Accept: text/event-stream`, the live events as server-sent events: one `progress` event per live event, then exactly one `result` (the output) or `error` (`OperationError`). A refusal before the first event is the ordinary JSON error.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaTurnEventsGetResponse"}},"text/event-stream":{"schema":{"description":"One server-sent event.","oneOf":[{"type":"object","required":["event","data"],"properties":{"event":{"const":"progress"},"data":{"$ref":"#/components/schemas/AlphaTurnEventsGetEvent"}}},{"type":"object","required":["event","data"],"properties":{"event":{"const":"result"},"data":{"$ref":"#/components/schemas/AlphaTurnEventsGetResponse"}}},{"type":"object","required":["event","data"],"properties":{"event":{"const":"error"},"data":{"$ref":"#/components/schemas/OperationError"}}}]}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/turns/select-version":{"post":{"operationId":"alpha.turns.select-version.v1","summary":"Select version turns","description":"Show an earlier successful answer to the same question as the current one, by its turn id and the question's first turn id; nothing runs again.","tags":["alpha"],"x-cli-name":"alpha-turns-select-version","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaTurnsSelectVersionRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaTurnsSelectVersionResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/turn-feedback/update":{"post":{"operationId":"alpha.turn-feedback.update.v1","summary":"Update turn feedback","description":"Rate one of the member's own Alpha answers up or down, with an optional comment; a later rating replaces it. With artifactId, rate instead one file version that answer produced, optionally with reason tags that belong to the rating (up: on_brief, accurate, looks_great, on_brand, ready_to_use; down: off_brief, wrong_numbers, layout_problems, off_brand, hard_to_edit, missing_content, text_errors).","tags":["alpha"],"x-cli-name":"alpha-turn-feedback-update","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaTurnFeedbackUpdateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaTurnFeedbackUpdateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/turn-feedback/{id}":{"get":{"operationId":"alpha.turn-feedback.get.v1","summary":"Get turn feedback","description":"Get the member's own rating of one of their Alpha answers, or, with artifactId, of one file version that answer produced (alpha_artifacts_get names each version's turn); feedback is null when they have given none.","tags":["alpha"],"x-cli-name":"alpha-turn-feedback-get","x-point11-scope":"alpha:read","security":[{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Alpha turn ID","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Alpha turn ID"}},{"name":"conversationId","in":"query","required":true,"description":"Alpha conversation ID","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Alpha conversation ID"}},{"name":"artifactId","in":"query","required":false,"description":"An artifact version this answer produced (as alpha.artifacts.get lists it with its turn), when the feedback is about that version rather than the answer","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"An artifact version this answer produced (as alpha.artifacts.get lists it with its turn), when the feedback is about that version rather than the answer"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaTurnFeedbackGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/proposed-actions/confirm":{"post":{"operationId":"alpha.proposed-actions.confirm.v1","summary":"Confirm proposed actions","description":"Carry out an action Alpha proposed in one of the member's answers (a Slack post, a tracker issue, a file save, a report run, paused Google Ads drafts). The user must approve it first; a repeat returns the same receipt.","tags":["alpha"],"x-cli-name":"alpha-proposed-actions-confirm","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}},{"name":"Point11-Confirm","in":"header","required":true,"description":"Explicit human confirmation of this operation's effect.","schema":{"type":"string","enum":["true"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaProposedActionsConfirmRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaProposedActionsConfirmResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/projects/create":{"post":{"operationId":"alpha.projects.create.v1","summary":"Create projects","description":"Create a private project, a named folder for the member's Alpha conversations; a member keeps at most 100.","tags":["alpha"],"x-cli-name":"alpha-projects-create","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaProjectsCreateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaProjectsCreateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/projects/update":{"post":{"operationId":"alpha.projects.update.v1","summary":"Update projects","description":"Rename one of the member's own Alpha projects (name), or set its instructions (instructions, at most 8000 characters; null clears them): standing guidance Alpha reads on every later question in the project's conversations.","tags":["alpha"],"x-cli-name":"alpha-projects-update","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaProjectsUpdateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaProjectsUpdateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/projects/delete":{"post":{"operationId":"alpha.projects.delete.v1","summary":"Delete projects","description":"Delete an Alpha project; every conversation in it stays. Its owner may delete it, and so may an organization admin once it is shared.","tags":["alpha"],"x-cli-name":"alpha-projects-delete","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaProjectsDeleteRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaProjectsDeleteResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/projects/set-visibility":{"post":{"operationId":"alpha.projects.set-visibility.v1","summary":"Set visibility projects","description":"Open one of the member's own Alpha projects to the whole organization, which shows teammates every conversation in it, or make it private again. Opening needs Alpha; the owner or an organization admin may close it.","tags":["alpha"],"x-cli-name":"alpha-projects-set-visibility","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaProjectsSetVisibilityRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaProjectsSetVisibilityResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/project-pins/create":{"post":{"operationId":"alpha.project-pins.create.v1","summary":"Create project pins","description":"Pin a file Alpha made (artifactId, as alpha_files_list lists it) to one of the member's own Alpha projects, so Alpha can open it on every later question in the project's conversations; a project pins at most 20. A shared project pins only files from its organization's shared projects. Pinning it again changes nothing.","tags":["alpha"],"x-cli-name":"alpha-project-pins-create","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaProjectPinsCreateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaProjectPinsCreateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/project-pins/delete":{"post":{"operationId":"alpha.project-pins.delete.v1","summary":"Delete project pins","description":"Unpin a file from one of the member's own Alpha projects; the file itself stays where it is.","tags":["alpha"],"x-cli-name":"alpha-project-pins-delete","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaProjectPinsDeleteRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaProjectPinsDeleteResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/conversation-members":{"get":{"operationId":"alpha.conversation-members.list.v1","summary":"List conversation members","description":"List the members an Alpha conversation the member may read is shared with by name (beside its owner, and beside a shared project's organization), oldest first.","tags":["alpha"],"x-cli-name":"alpha-conversation-members-list","x-point11-scope":"alpha:read","security":[{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"conversationId","in":"query","required":true,"description":"The Alpha conversation","schema":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The Alpha conversation"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaConversationMembersListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/conversation-members/add":{"post":{"operationId":"alpha.conversation-members.add.v1","summary":"Add conversation members","description":"Share one of the member's own Alpha conversations, and its files, with another member of the organization by their email, without sharing its project: they may then read it and, when their role uses Alpha, ask in it. Adding someone already on it returns them. Refused for an address that is no member (invite them first), at 25 names, and while acting as another member.","tags":["alpha"],"x-cli-name":"alpha-conversation-members-add","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaConversationMembersAddRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaConversationMembersAddResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/conversation-members/remove":{"post":{"operationId":"alpha.conversation-members.remove.v1","summary":"Remove conversation members","description":"Take a member off an Alpha conversation shared with them by name: its owner removes anyone, and a member removes themselves. Their access ends at once; removed is false when they were not on it.","tags":["alpha"],"x-cli-name":"alpha-conversation-members-remove","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaConversationMembersRemoveRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaConversationMembersRemoveResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/artifacts/{id}":{"get":{"operationId":"alpha.artifacts.get.v1","summary":"Get artifacts","description":"Get every version of a file Alpha made in a conversation the member may read, newest first, with the newest Markdown document's text. An API key reads only files from conversations it started.","tags":["alpha"],"x-cli-name":"alpha-artifacts-get","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of any version of a file Alpha made","schema":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The ID of any version of a file Alpha made"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaArtifactsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/artifacts/outline":{"get":{"operationId":"alpha.artifacts.outline.v1","summary":"Outline artifacts","description":"Get what one saved version of a PowerPoint, Word or Excel file Alpha made holds, as the file Sandbox read it from its bytes: slides with their shape ids, names, placeholders, text and notes; paragraphs with their styles and runs; sheets with their used ranges and charts. The units alpha_artifacts_edit addresses. Null for a version saved before outlines were recorded.","tags":["alpha"],"x-cli-name":"alpha-artifacts-outline","x-point11-scope":"alpha:read","security":[{"oauth":[]}],"parameters":[{"name":"id","in":"query","required":true,"description":"The ID of any version of a file Alpha made","schema":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The ID of any version of a file Alpha made"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaArtifactsOutlineResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/artifacts/edit":{"post":{"operationId":"alpha.artifacts.edit.v1","summary":"Edit artifacts","description":"Edit a saved PowerPoint, Word or Excel file Alpha made by operations on its units (shape text, speaker notes, slide order, paragraph or run text, cell values and formulas, native charts) and save the result as its next version, without a model turn. The file Sandbox applies them to the file itself, recalculates a workbook and renders the preview; the version edited from stays unchanged and must still be the latest. Returns the new version.","tags":["alpha"],"x-cli-name":"alpha-artifacts-edit","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaArtifactsEditRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaArtifactsEditResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/artifacts/download":{"get":{"operationId":"alpha.artifacts.download.v1","summary":"Download artifacts","description":"Download one version of a file Alpha made (by that version's id, as alpha_artifacts_get lists them) that the member may read: its file name, media type and size, and a short-lived url that GETs its bytes (null when this deployment cannot sign one). An API key reads only files from conversations it started.","tags":["alpha"],"x-cli-name":"alpha-artifacts-download","x-point11-scope":"alpha:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"query","required":true,"description":"The ID of any version of a file Alpha made","schema":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The ID of any version of a file Alpha made"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaArtifactsDownloadResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/artifact-inspections/{id}":{"get":{"operationId":"alpha.artifact-inspections.get.v1","summary":"Get artifact inspections","description":"Get what a model recorded when it rendered and reviewed a file Alpha made (by the version's id): each page or image it inspected, its outcome and findings, and the stored file's SHA-256; inspection is null when no review was recorded. A file from a conversation opens only to whoever may read that conversation.","tags":["alpha"],"x-cli-name":"alpha-artifact-inspections-get","x-point11-scope":"alpha:read","security":[{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of any version of a file Alpha made","schema":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The ID of any version of a file Alpha made"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaArtifactInspectionsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/artifact-packages/{id}":{"get":{"operationId":"alpha.artifact-packages.get.v1","summary":"Get artifact packages","description":"Get one version of a package Alpha assembled in a conversation the member may read, with every member file it pins in manifest order (null for a member no longer available). Refused while new Alpha work is closed for the organization.","tags":["alpha"],"x-cli-name":"alpha-artifact-packages-get","x-point11-scope":"alpha:read","security":[{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of any version of a file Alpha made","schema":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The ID of any version of a file Alpha made"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaArtifactPackagesGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/artifact-packages/export":{"get":{"operationId":"alpha.artifact-packages.export.v1","summary":"Export artifact packages","description":"Export one version of a package Alpha assembled (as alpha_artifact_packages_get reads it) as its files: package.md, every pinned member at its exact version with its PDF preview, a website member's source, a referenced ad suite's package under ads/, manifest.json and README.md. Each stored file carries a short-lived url that GETs its bytes; each generated file carries its content inline. Refused while new Alpha work is closed, and when any pinned file is unavailable.","tags":["alpha"],"x-cli-name":"alpha-artifact-packages-export","x-point11-scope":"alpha:read","security":[{"oauth":[]}],"parameters":[{"name":"id","in":"query","required":true,"description":"The ID of the package version to export","schema":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The ID of the package version to export"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaArtifactPackagesExportResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/websites/export":{"get":{"operationId":"alpha.websites.export.v1","summary":"Export websites","description":"Export one version of a website Alpha built (by that version's id, as alpha_artifacts_get lists them) as its project files under website/: every source file as built, including package-lock.json, and each pinned asset at the exact digest the version recorded. Each stored file carries a short-lived url that GETs its bytes; each generated file carries its content inline; the dashboard streams one ZIP. Refused while new Alpha work is closed, and when any pinned file is unavailable.","tags":["alpha"],"x-cli-name":"alpha-websites-export","x-point11-scope":"alpha:read","security":[{"oauth":[]}],"parameters":[{"name":"id","in":"query","required":true,"description":"The ID of the website version to export","schema":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The ID of the website version to export"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaWebsitesExportResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/websites/edit-text":{"post":{"operationId":"alpha.websites.edit-text.v1","summary":"Edit text websites","description":"Change one piece of text in a website Alpha built, with no model turn: the version (its id), the element's source location as Alpha Chat's preview element picker reports it (path, line, column), the text the element shows, and its new text. The text must be one JSX text or string literal inside that element in the version's source; the edited source is built and accepted exactly as Alpha's own revisions are, which can take a few minutes, and saved as the website's next version, which is returned. Refused while new Alpha work is closed, while acting as another member, while another edit of the version builds, and while a turn of its conversation runs.","tags":["alpha"],"x-cli-name":"alpha-websites-edit-text","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaWebsitesEditTextRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaWebsitesEditTextResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/artifacts/revise":{"post":{"operationId":"alpha.artifacts.revise.v1","summary":"Revise artifacts","description":"Save an edited Markdown document as a new version of a document Alpha made; the version it was edited from stays unchanged. Returns the new version.","tags":["alpha"],"x-cli-name":"alpha-artifacts-revise","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaArtifactsReviseRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaArtifactsReviseResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/artifacts/restore":{"post":{"operationId":"alpha.artifacts.restore.v1","summary":"Restore artifacts","description":"Restore an earlier version of a file Alpha made (by that version's id, as alpha_artifacts_get lists them) as its newest version, naming the newest version you read. The new version's bytes are exactly the earlier version's, copied with no model turn; the versions before it stay unchanged. Restores documents, CSVs, and built Office files and PDFs; any other kind (a website, which is rebuilt, an image, a brand kit) is restored by asking Alpha in chat and is refused here. Refused when a newer version has been saved since. Returns the new version.","tags":["alpha"],"x-cli-name":"alpha-artifacts-restore","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaArtifactsRestoreRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaArtifactsRestoreResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/artifacts/rename":{"post":{"operationId":"alpha.artifacts.rename.v1","summary":"Rename artifacts","description":"Rename a file Alpha made, by any version's id, in a conversation the member may ask in: every version of it shows title (1 to 160 characters) in the Files library and its chat, and a later version keeps it; null returns it to the name Alpha gave it. What Alpha recorded is unchanged. Refused while acting as another member.","tags":["alpha"],"x-cli-name":"alpha-artifacts-rename","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaArtifactsRenameRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaArtifactsRenameResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/artifacts/delete":{"post":{"operationId":"alpha.artifacts.delete.v1","summary":"Delete artifacts","description":"Delete a file Alpha made in one of the member's own conversations, by any version's id: every version, and each one's PDF preview or website captures, stops being served at once and its stored objects are removed. Refused (409 PRECONDITION_FAILED, naming why) while the file has a public link, is pinned by a package, or was delivered to an Advisor action or plan run, and while acting as another member.","tags":["alpha"],"x-cli-name":"alpha-artifacts-delete","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaArtifactsDeleteRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaArtifactsDeleteResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/microsoft-files/{id}":{"get":{"operationId":"alpha.microsoft-files.get.v1","summary":"Get microsoft files","description":"Get a PowerPoint preview of the OneDrive copy of a presentation Alpha made, through the member's own Microsoft connection. Open the copy itself with alpha_artifacts_open_in.","tags":["alpha"],"x-cli-name":"alpha-microsoft-files-get","x-point11-scope":"alpha:read","security":[{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of any version of a file Alpha made","schema":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The ID of any version of a file Alpha made"}},{"name":"open","in":"query","required":false,"description":"Retired: open the copy with alpha.artifacts.open-in; true is refused","schema":{"description":"Retired: open the copy with alpha.artifacts.open-in; true is refused","type":"boolean"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaMicrosoftFilesGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/artifacts/open-in":{"post":{"operationId":"alpha.artifacts.open-in.v1","summary":"Open in artifacts","description":"Open one version of a PowerPoint, Word or Excel file Alpha made, that the member may read, in their own Google Drive (converted to Google Slides, Docs or Sheets) or OneDrive (PowerPoint, Word or Excel for the web): the first call copies that version into a Point11 folder there and later calls reopen the same copy, making a new one only when it was deleted. Answers the copy's url. When the member must first connect Google Drive or OneDrive, the dashboard answers a consent url that returns to the file, to finish in the same browser; any other caller is told to connect it in Point11's Settings first. The copy never syncs back to Point11. Uses the member's own connection.","tags":["alpha"],"x-cli-name":"alpha-artifacts-open-in","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaArtifactsOpenInRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaArtifactsOpenInResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/page-publications/{id}":{"get":{"operationId":"alpha.page-publications.get.v1","summary":"Get page publications","description":"Get what is live on the public link of a website, deck, PDF, or image Alpha made, by any version's id, or null when it is not published. suspended is true when Point11 took the link down.","tags":["alpha"],"x-cli-name":"alpha-page-publications-get","x-point11-scope":"alpha:read","security":[{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of any version of an Alpha website, deck, PDF, or image","schema":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The ID of any version of an Alpha website, deck, PDF, or image"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaPagePublicationsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/page-publications/create":{"post":{"operationId":"alpha.page-publications.create.v1","summary":"Create page publications","description":"Publish one version of a website Alpha made on an unguessable public link, or move its live link to this version: it runs as its static export, never indexed until made discoverable. Anything but a website is refused (NOT_A_PAGE). Anyone with the link can view it; an organization keeps at most 50 live links.","tags":["alpha"],"x-cli-name":"alpha-page-publications-create","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaPagePublicationsCreateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaPagePublicationsCreateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/page-publications/update":{"post":{"operationId":"alpha.page-publications.update.v1","summary":"Update page publications","description":"Set, change, or clear (null) a public link's password, or change whether search engines may list it.","tags":["alpha"],"x-cli-name":"alpha-page-publications-update","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaPagePublicationsUpdateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaPagePublicationsUpdateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/page-publications/delete":{"post":{"operationId":"alpha.page-publications.delete.v1","summary":"Delete page publications","description":"Take a website, deck, PDF, or image off its public link at once; ended is false when nothing was live.","tags":["alpha"],"x-cli-name":"alpha-page-publications-delete","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaPagePublicationsDeleteRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaPagePublicationsDeleteResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/page-leads":{"get":{"operationId":"alpha.page-leads.list.v1","summary":"List page leads","description":"List the leads a published Alpha website's declared forms collected, newest first, across every publication the page has had, by any version's id (pageId): each lead's form, the declared fields the visitor answered, and when it arrived; beside that version's declared forms with their field labels, and how many days a lead is kept.","tags":["alpha"],"x-cli-name":"alpha-page-leads-list","x-point11-scope":"alpha:read","security":[{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"pageId","in":"query","required":true,"description":"The ID of any version of an Alpha page","schema":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The ID of any version of an Alpha page"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaPageLeadsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/page-leads/export":{"get":{"operationId":"alpha.page-leads.export.v1","summary":"Export page leads","description":"Export a published Alpha website's leads as CSV, newest first, by any version's id (pageId), up to 500 rows per call: the first call's content opens with the header row, and each nextCursor continues the same columns over the leads that had arrived when the export began. Needs the export capability, refuses a member acting as another, and records each call in the audit log with its row count.","tags":["alpha"],"x-cli-name":"alpha-page-leads-export","x-point11-scope":"alpha:read","security":[{"oauth":[]}],"parameters":[{"name":"pageId","in":"query","required":true,"description":"The ID of any version of an Alpha page","schema":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The ID of any version of an Alpha page"}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous call","schema":{"description":"Opaque cursor returned as nextCursor by the previous call","type":"string","minLength":1,"maxLength":16384}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaPageLeadsExportResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/page-leads/delete":{"post":{"operationId":"alpha.page-leads.delete.v1","summary":"Delete page leads","description":"Delete leads a published Alpha website collected, by any version's id (pageId) and the leads' ids: one, or a selection of up to 100. A lead the page does not hold is skipped; deleted is how many went.","tags":["alpha"],"x-cli-name":"alpha-page-leads-delete","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaPageLeadsDeleteRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaPageLeadsDeleteResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/attachments/delete":{"post":{"operationId":"alpha.attachments.delete.v1","summary":"Delete attachments","description":"Discard a file the member uploaded to a conversation that no question has used yet; repeating it is harmless.","tags":["alpha"],"x-cli-name":"alpha-attachments-delete","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAttachmentsDeleteRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAttachmentsDeleteResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/attachments/reserve-upload":{"post":{"operationId":"alpha.attachments.reserve-upload.v1","summary":"Reserve upload attachments","description":"Deprecated: use alpha.attachments.reserve-upload.v2 (alpha_attachments_reserve_upload_v2), which also takes a PowerPoint deck; this version refuses one. Reserve a file the member will attach to one of their Alpha conversations (a new conversation id starts one) and get a one-minute presigned PUT for its bytes; a retry with the same idempotency key returns the same attachment with a fresh URL. Send the file as that request's body, then call alpha_attachments_complete_upload_v2.","deprecated":true,"tags":["alpha"],"x-cli-name":"alpha-attachments-reserve-upload","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAttachmentsReserveUploadRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAttachmentsReserveUploadResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/attachments/reserve-upload-v2":{"post":{"operationId":"alpha.attachments.reserve-upload.v2","summary":"Reserve upload attachments (v2)","description":"Reserve a file the member will attach to one of their Alpha conversations (a new conversation id starts one) and get a one-minute presigned PUT for its bytes; a retry with the same idempotency key returns the same attachment with a fresh URL. Send the file as that request's body, then call alpha_attachments_complete_upload_v2. Takes every format an attachment may be, a PowerPoint deck included.","tags":["alpha"],"x-cli-name":"alpha-attachments-reserve-upload-v2","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAttachmentsReserveUploadV2Request"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAttachmentsReserveUploadV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/attachments/complete-upload":{"post":{"operationId":"alpha.attachments.complete-upload.v1","summary":"Complete upload attachments","description":"Deprecated: use alpha.attachments.complete-upload.v2 (alpha_attachments_complete_upload_v2), which also finishes a PowerPoint deck reserved through alpha_attachments_reserve_upload_v2; this version refuses one (415 UNSUPPORTED_ATTACHMENT). Finish an attachment upload: Point11 reads the stored file back, checks its size and format, extracts a document's text, and returns the ready attachment to name in alpha_conversations_send. Omit etag when the upload's answer was lost; a refusal carrying details.retryAfterMs is retried after that wait.","deprecated":true,"tags":["alpha"],"x-cli-name":"alpha-attachments-complete-upload","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAttachmentsCompleteUploadRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAttachmentsCompleteUploadResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/attachments/complete-upload-v2":{"post":{"operationId":"alpha.attachments.complete-upload.v2","summary":"Complete upload attachments (v2)","description":"Finish an attachment upload: Point11 reads the stored file back, checks its size and format, extracts a document's text, and returns the ready attachment to name in alpha_conversations_send. Omit etag when the upload's answer was lost; a refusal carrying details.retryAfterMs is retried after that wait. Answers every format an attachment may be, a PowerPoint deck included.","tags":["alpha"],"x-cli-name":"alpha-attachments-complete-upload-v2","x-point11-scope":"alpha:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAttachmentsCompleteUploadV2Request"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAttachmentsCompleteUploadV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/alpha/attachments/download":{"get":{"operationId":"alpha.attachments.download.v1","summary":"Download attachments","description":"Download a file attached to an Alpha conversation, by its id: its uploader may, and so may anyone who may read the conversation once a question carried it. Answers the file's name, type and size, and a short-lived url that GETs its bytes.","tags":["alpha"],"x-cli-name":"alpha-attachments-download","x-point11-scope":"alpha:read","security":[{"oauth":[]}],"parameters":[{"name":"id","in":"query","required":true,"description":"Alpha attachment ID","schema":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"Alpha attachment ID"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlphaAttachmentsDownloadResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/campaigns/launch":{"post":{"operationId":"research.campaigns.launch.v1","summary":"Launch campaigns","description":"Start a Research study on a business profile's customers, once or on a weekly or monthly quota, for an organization already subscribed to Point11 Analytics. Returns the campaign and the billing run of its first interviews; an organization without an active subscription is refused, since subscribing happens only in the dashboard. Every interview is billed as delivered usage against the organization's allowance, then approved overage; a weekly or monthly study consumes allowance on every run.","tags":["research"],"x-cli-name":"research-campaigns-launch","x-point11-scope":"research:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchCampaignsLaunchRequest"}}}},"responses":{"202":{"description":"Accepted: the durable run started. Follow it with `GET /api/v1/platform/runs-v2/{id}`.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchCampaignsLaunchResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/campaign-segments/{id}":{"get":{"operationId":"research.campaign-segments.get.v1","summary":"Get campaign segments","description":"Get the segment entries one Research campaign's active respondents hold: the customers themselves, audiences, channels, and stores, each an id and label. Pass { axis, id } entries as `segments` to research_results_get_v7 or research_conversations_list_v2 to narrow them.","tags":["research"],"x-cli-name":"research-campaign-segments-get","x-point11-scope":"research:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The campaign id from research.campaigns.list.v1.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The campaign id from research.campaigns.list.v1."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchCampaignSegmentsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/campaign-customers-v3":{"get":{"operationId":"research.campaign-customers.list.v3","summary":"List campaign customers (v3)","description":"Deprecated: use research.campaign-customers.list.v4 (research_campaign_customers_list_v4), which names no faviconLightUrl or faviconDarkUrl: a favicon is one image for both themes, faviconUrl. This version answers the same and names both, never sent. List a Research campaign's current customers a page at a time, newest first: every customer on its roster who is still active in its business profile, with their traits, audiences, and sources. query narrows by name or job title and groupIds to members of those audiences; selectedGroupIds also answers which of the matching customers belong to those audiences, across every page. Pass a customer's id as a { axis: customer, id } entry in `segments` to research_results_get_v7 or research_conversations_list_v2 to narrow them to that customer. A campaign your organization does not own is not found. Page with nextCursor at the same limit.","deprecated":true,"tags":["research"],"x-cli-name":"research-campaign-customers-list-v3","x-point11-scope":"research:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"campaignId","in":"query","required":true,"description":"The campaign id from research.campaigns.list.v1.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The campaign id from research.campaigns.list.v1."}},{"name":"query","in":"query","required":false,"schema":{"type":"string","maxLength":200}},{"name":"groupIds","in":"query","required":false,"schema":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},{"name":"selectedGroupIds","in":"query","required":false,"schema":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},{"name":"filters","in":"query","required":false,"description":"Field conditions, each `<field>:<operator>:<value>`. Text fields (location, employer, trigger) take contains, does_not_contain, is or starts_with and the words. Number fields (age, householdIncome, companySize, annualRevenue) take gt, gte, lt, lte or eq and a number, or between and `min..max`. Classification fields, each band under its fact's key as <key>.band (gender, age.band, language, market, areaType, education, lifeStage, householdIncome.band, occupation, seniority, companySize.band, buyerType, audience, product, channel, buyerRole, intentStage, job, triggerType), take is_any_of or is_none_of and comma-separated ids from business_customer_filter_options_get_v2 (buyerType takes consumer or organization), `none` for a customer with no value. createdAt takes on_or_after or on_or_before and an ISO date, or between and `from..to`, read in UTC.","schema":{"description":"Field conditions, each `<field>:<operator>:<value>`. Text fields (location, employer, trigger) take contains, does_not_contain, is or starts_with and the words. Number fields (age, householdIncome, companySize, annualRevenue) take gt, gte, lt, lte or eq and a number, or between and `min..max`. Classification fields, each band under its fact's key as <key>.band (gender, age.band, language, market, areaType, education, lifeStage, householdIncome.band, occupation, seniority, companySize.band, buyerType, audience, product, channel, buyerRole, intentStage, job, triggerType), take is_any_of or is_none_of and comma-separated ids from business_customer_filter_options_get_v2 (buyerType takes consumer or organization), `none` for a customer with no value. createdAt takes on_or_after or on_or_before and an ISO date, or between and `from..to`, read in UTC.","maxItems":20,"type":"array","items":{"type":"string","minLength":5,"maxLength":4000,"pattern":"^[A-Za-z]+(?:\\.band)?:[a-z_]+:.+$"}}},{"name":"filterMatch","in":"query","required":false,"description":"Whether a customer matches every condition (all, the default) or any one","schema":{"description":"Whether a customer matches every condition (all, the default) or any one","type":"string","enum":["all","any"]}},{"name":"lifecycleStatus","in":"query","required":false,"description":"active (default): the campaign's customers on its roster now; archived: the customers it has held who are archived since; all: both.","schema":{"description":"active (default): the campaign's customers on its roster now; archived: the customers it has held who are archived since; all: both.","type":"string","enum":["active","archived","all"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchCampaignCustomersListV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/campaign-customers-v4":{"get":{"operationId":"research.campaign-customers.list.v4","summary":"List campaign customers (v4)","description":"List a Research campaign's current customers a page at a time, newest first: every customer on its roster who is still active in its business profile, with their traits, audiences, and sources. query narrows by name or job title and groupIds to members of those audiences; selectedGroupIds also answers which of the matching customers belong to those audiences, across every page. Pass a customer's id as a { axis: customer, id } entry in `segments` to research_results_get_v7 or research_conversations_list_v2 to narrow them to that customer. A campaign your organization does not own is not found. Page with nextCursor at the same limit.","tags":["research"],"x-cli-name":"research-campaign-customers-list-v4","x-point11-scope":"research:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"campaignId","in":"query","required":true,"description":"The campaign id from research.campaigns.list.v1.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The campaign id from research.campaigns.list.v1."}},{"name":"query","in":"query","required":false,"schema":{"type":"string","maxLength":200}},{"name":"groupIds","in":"query","required":false,"schema":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},{"name":"selectedGroupIds","in":"query","required":false,"schema":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},{"name":"filters","in":"query","required":false,"description":"Field conditions, each `<field>:<operator>:<value>`. Text fields (location, employer, trigger) take contains, does_not_contain, is or starts_with and the words. Number fields (age, householdIncome, companySize, annualRevenue) take gt, gte, lt, lte or eq and a number, or between and `min..max`. Classification fields, each band under its fact's key as <key>.band (gender, age.band, language, market, areaType, education, lifeStage, householdIncome.band, occupation, seniority, companySize.band, buyerType, audience, product, channel, buyerRole, intentStage, job, triggerType), take is_any_of or is_none_of and comma-separated ids from business_customer_filter_options_get_v2 (buyerType takes consumer or organization), `none` for a customer with no value. createdAt takes on_or_after or on_or_before and an ISO date, or between and `from..to`, read in UTC.","schema":{"description":"Field conditions, each `<field>:<operator>:<value>`. Text fields (location, employer, trigger) take contains, does_not_contain, is or starts_with and the words. Number fields (age, householdIncome, companySize, annualRevenue) take gt, gte, lt, lte or eq and a number, or between and `min..max`. Classification fields, each band under its fact's key as <key>.band (gender, age.band, language, market, areaType, education, lifeStage, householdIncome.band, occupation, seniority, companySize.band, buyerType, audience, product, channel, buyerRole, intentStage, job, triggerType), take is_any_of or is_none_of and comma-separated ids from business_customer_filter_options_get_v2 (buyerType takes consumer or organization), `none` for a customer with no value. createdAt takes on_or_after or on_or_before and an ISO date, or between and `from..to`, read in UTC.","maxItems":20,"type":"array","items":{"type":"string","minLength":5,"maxLength":4000,"pattern":"^[A-Za-z]+(?:\\.band)?:[a-z_]+:.+$"}}},{"name":"filterMatch","in":"query","required":false,"description":"Whether a customer matches every condition (all, the default) or any one","schema":{"description":"Whether a customer matches every condition (all, the default) or any one","type":"string","enum":["all","any"]}},{"name":"lifecycleStatus","in":"query","required":false,"description":"active (default): the campaign's customers on its roster now; archived: the customers it has held who are archived since; all: both.","schema":{"description":"active (default): the campaign's customers on its roster now; archived: the customers it has held who are archived since; all: both.","type":"string","enum":["active","archived","all"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchCampaignCustomersListV4Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/campaigns":{"get":{"operationId":"research.campaigns.list.v1","summary":"List campaigns","description":"List the organization's Research campaigns, newest first, optionally only one study's. Pass the returned nextCursor to continue; nextCursor is null on the last page.","tags":["research"],"x-cli-name":"research-campaigns-list","x-point11-scope":"research:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Campaigns per page (default 20, max 1000).","schema":{"default":20,"description":"Campaigns per page (default 20, max 1000).","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque nextCursor from a previous call.","schema":{"description":"Opaque nextCursor from a previous call.","type":"string","minLength":1,"maxLength":256}},{"name":"study","in":"query","required":false,"description":"Only this study's campaigns; omit for every Research campaign.","schema":{"description":"Only this study's campaigns; omit for every Research campaign.","type":"string","enum":["ad_copy","brand_health","offers","pricing","product","product_launch","sales","custom","product_roadmap","purchasing","competitors"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchCampaignsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/campaigns/{id}":{"get":{"operationId":"research.campaigns.get.v1","summary":"Get campaigns","description":"Get one Research campaign by id, with how many distinct stores its active members are bound to (0 for a profile campaign).","tags":["research"],"x-cli-name":"research-campaigns-get","x-point11-scope":"research:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The campaign id from research.campaigns.list.v1.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The campaign id from research.campaigns.list.v1."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchCampaignsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/campaign-settings-v4/{id}":{"get":{"operationId":"research.campaign-settings.get.v4","summary":"Get campaign settings (v4)","description":"Names a study's customer assumptions alongside its questions and media. Get a Research campaign's saved study, targeting and schedule, active, paused or archived alike: the study, its description, its questions and the file or video each shows, the customer assumptions every respondent answers under, the interviews each quota period takes, whom they reach, the competitors it compares with, and its schedule as campaigns_summaries_get_v2 names it. Its progress and standing are campaigns_summaries_get_v2's.","tags":["research"],"x-cli-name":"research-campaign-settings-get-v4","x-point11-scope":"research:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The Research campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The Research campaign id."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchCampaignSettingsGetV4Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/campaign-settings-v3/{id}":{"get":{"operationId":"research.campaign-settings.get.v3","summary":"Get campaign settings (v3)","description":"Deprecated: use research.campaign-settings.get.v4 (research_campaign_settings_get_v4), which also names a study's customer assumptions; this version leaves them out, so a study that states some reads as a version 4 study without them. Get a Research campaign's saved study, targeting and schedule, active, paused or archived alike: the study, its description, its questions and the file or video each shows, the interviews each quota period takes, whom they reach, the competitors it compares with, and its schedule as campaigns_summaries_get_v2 names it. Its progress and standing are campaigns_summaries_get_v2's.","deprecated":true,"tags":["research"],"x-cli-name":"research-campaign-settings-get-v3","x-point11-scope":"research:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The Research campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The Research campaign id."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchCampaignSettingsGetV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/campaign-settings-v2/{id}":{"get":{"operationId":"research.campaign-settings.get.v2","summary":"Get campaign settings (v2)","description":"Deprecated: use research.campaign-settings.get.v3 (research_campaign_settings_get_v3) for native audio; this version leaves audio out: a question that shows audio shows no file. Get a Research campaign's saved study, targeting and schedule, active, paused or archived alike: the study, its description, its questions and the file or video each shows, the interviews each quota period takes, whom they reach, the competitors it compares with, and its schedule as campaigns_summaries_get_v2 names it. Its progress and standing are campaigns_summaries_get_v2's.","deprecated":true,"tags":["research"],"x-cli-name":"research-campaign-settings-get-v2","x-point11-scope":"research:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The Research campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The Research campaign id."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchCampaignSettingsGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/campaign-settings/{id}":{"get":{"operationId":"research.campaign-settings.get.v1","summary":"Get campaign settings","description":"Deprecated: use research.campaign-settings.get.v2 (research_campaign_settings_get_v2), which also names a question's video; this version leaves a video out, so a question that shows one reads as showing no file, and names neither the study's description nor its schedule. Get a Research campaign's saved study and targeting, active, paused or archived alike: the study, its questions and what it shows, the interviews each quota period takes, whom they reach, and the competitors it compares with. Its schedule, progress and standing are campaigns.summaries.get.v2's.","deprecated":true,"tags":["research"],"x-cli-name":"research-campaign-settings-get","x-point11-scope":"research:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The Research campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The Research campaign id."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchCampaignSettingsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/campaign-settings-quotes/{id}":{"get":{"operationId":"research.campaign-settings-quotes.get.v1","summary":"Get campaign settings quotes","description":"Review a Save of a Research campaign's settings before making it, writing nothing: each change and when it starts (from the next admission day), the change in estimated monthly interviews at today's price, Billing's answer to the extra work and how the change reaches results (an edited question starts fresh from its first answer after the change; every unchanged question keeps its history). Pass the settingsRevision research_campaign_settings_get_v4 returned as expectedSettingsRevision; refused when the settings changed since. `id` is the campaign's id.","tags":["research"],"x-cli-name":"research-campaign-settings-quotes-get","x-point11-scope":"research:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The Research campaign's id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The Research campaign's id."}},{"name":"expectedSettingsRevision","in":"query","required":true,"description":"The settingsRevision the settings read (or a quote) returned.","schema":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The settingsRevision the settings read (or a quote) returned."}},{"name":"name","in":"query","required":false,"description":"The campaign's new name.","schema":{"type":"string","minLength":1,"maxLength":120,"description":"The campaign's new name."}},{"name":"targetInterviewCount","in":"query","required":false,"description":"Interviews each period takes, one per customer: raising it adds the next eligible customers in the study's own sampling order, lowering it removes the newest joined first (named in the quote's customersLeaving) and cancels their interviews not yet started.","schema":{"description":"Interviews each period takes, one per customer: raising it adds the next eligible customers in the study's own sampling order, lowering it removes the newest joined first (named in the quote's customersLeaving) and cancels their interviews not yet started.","type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},{"name":"audience","in":"query","required":false,"description":"Whom customers added later are drawn from: every eligible customer (all) or members of targetedGroupIds (groups). The current customers stay.","schema":{"description":"Whom customers added later are drawn from: every eligible customer (all) or members of targetedGroupIds (groups). The current customers stay.","type":"string","enum":["all","groups"]}},{"name":"targetedGroupIds","in":"query","required":false,"description":"The audiences, with audience groups.","schema":{"description":"The audiences, with audience groups.","minItems":1,"maxItems":20,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},{"name":"frequency","in":"query","required":false,"description":"The period a repeating study interviews each customer once in; a new period starts at the next admission day.","schema":{"description":"The period a repeating study interviews each customer once in; a new period starts at the next admission day.","type":"string","enum":["weekly","monthly"]}},{"name":"studyChanged","in":"query","required":false,"description":"Whether the Save changes the study; an edited question starts fresh in results.","schema":{"description":"Whether the Save changes the study; an edited question starts fresh in results.","type":"boolean"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchCampaignSettingsQuotesGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/campaign-settings/update":{"post":{"operationId":"research.campaign-settings.update.v1","summary":"Update campaign settings","description":"Save a Research campaign's settings in place, all or nothing: its name, interview count, audience, schedule and study, from the next admission day; results continue on the same campaign, where an edited question starts fresh from its first answer after the change and every unchanged question keeps its history. Whom it interviews (its profile's customers or its stores') never changes. Nothing is charged at Save: delivered interviews accrue against the plan. Pass expectedSettingsRevision from research_campaign_settings_get_v4; a Save whose settings moved since is refused (STALE_WRITE). Pass reviewedEstimate from research_campaign_settings_quotes_get to also refuse one whose estimate moved, or null to save at the current estimate. A person confirms it.","tags":["research"],"x-cli-name":"research-campaign-settings-update","x-point11-scope":"research:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}},{"name":"Point11-Confirm","in":"header","required":true,"description":"Explicit human confirmation of this operation's effect.","schema":{"type":"string","enum":["true"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchCampaignSettingsUpdateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchCampaignSettingsUpdateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/conversations-v2":{"get":{"operationId":"research.conversations.list.v2","summary":"List conversations (v2)","description":"List Research interviews (one respondent's conversation each), newest first, each with its accepted answers coded (tone, tags, chosen options, a ranking's order, a scale's rating, a task's success), optionally narrowed to one campaign, a segment scope, and respondents who gave given answers (a chosen option or a coded tone). With campaignId it also names the campaign's study questions and counts the interviews before the answer filters. Pass the returned nextCursor with the same campaignId, segments and answer filters to continue after the last interview listed, at any page size; interviews that arrive mid-walk never shift a page, and nextCursor is null on the last page.","tags":["research"],"x-cli-name":"research-conversations-list-v2","x-point11-scope":"research:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Interviews per page (default 20, max 100).","schema":{"description":"Interviews per page (default 20, max 100).","type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","required":false,"description":"Opaque nextCursor from a previous call; the page continues after the last interview that call listed. Send the same campaignId, customerId and segments to continue the same list.","schema":{"description":"Opaque nextCursor from a previous call; the page continues after the last interview that call listed. Send the same campaignId, customerId and segments to continue the same list.","type":"string","minLength":1,"maxLength":256}},{"name":"campaignId","in":"query","required":false,"description":"Only this Research campaign's interviews; omit for every campaign.","schema":{"description":"Only this Research campaign's interviews; omit for every campaign.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"customerId","in":"query","required":false,"description":"Only this customer's interviews; omit for every customer.","schema":{"description":"Only this customer's interviews; omit for every customer.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"segments","in":"query","required":false,"description":"Only respondents inside these segment entries; empty or omitted is everyone. Accepts only the audience, channel, store, customer axes; an entry on any other axis is refused as 400 INVALID_INPUT.","content":{"application/json":{"schema":{"description":"Only respondents inside these segment entries; empty or omitted is everyone. Accepts only the audience, channel, store, customer axes; an entry on any other axis is refused as 400 INVALID_INPUT.","maxItems":50,"type":"array","items":{"type":"object","properties":{"axis":{"type":"string","enum":["audience","channel","market","age","householdIncome","education","lifeStage","areaType","companySize","buyerRole","seniority","occupation","job","triggerType","intentStage","language","gender","store","customer"]},"id":{"type":"string","minLength":1,"maxLength":512}},"required":["axis","id"],"additionalProperties":false}}}}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchConversationsListV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/conversations-v3/{id}":{"get":{"operationId":"research.conversations.get.v3","summary":"Get conversations (v3)","description":"Supports original MP3 and WAV audio alongside the existing study media. Get one Research interview by id: its full transcript (each question asked, the respondent's answer, and any file or video the question showed), each accepted answer as the analysis coded it (tone, tags, chosen options), and the outcome of each computer task it ran.","tags":["research"],"x-cli-name":"research-conversations-get-v3","x-point11-scope":"research:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The interview id from research.conversations.list.v2.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The interview id from research.conversations.list.v2."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchConversationsGetV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/conversations-v2/{id}":{"get":{"operationId":"research.conversations.get.v2","summary":"Get conversations (v2)","description":"Deprecated: use research.conversations.get.v3 (research_conversations_get_v3) for native audio; this version leaves audio out: a turn that showed audio shows no file. Get one Research interview by id: its full transcript (each question asked, the respondent's answer, and any file or video the question showed), each accepted answer as the analysis coded it (tone, tags, chosen options), and the outcome of each computer task it ran.","deprecated":true,"tags":["research"],"x-cli-name":"research-conversations-get-v2","x-point11-scope":"research:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The interview id from research.conversations.list.v2.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The interview id from research.conversations.list.v2."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchConversationsGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/conversations/{id}":{"get":{"operationId":"research.conversations.get.v1","summary":"Get conversations","description":"Deprecated: use research.conversations.get.v2 (research_conversations_get_v2), which also names a video a question showed; this version leaves a video out, so that turn reads as showing no file. Get one Research interview by id: its full transcript (each question asked, the respondent's answer, and any file the question showed) and the outcome of each computer task it ran.","deprecated":true,"tags":["research"],"x-cli-name":"research-conversations-get","x-point11-scope":"research:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The interview id from research.conversations.list.v2.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The interview id from research.conversations.list.v2."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchConversationsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/drafts-v3/{id}":{"get":{"operationId":"research.drafts.get.v3","summary":"Get drafts (v3)","description":"Supports original MP3 and WAV audio alongside the existing study media. Get one of the signed-in user's saved Research study drafts by id: its revision and the unfinished study document (name, material, questions and the file or video each shows, schedule, audience). Drafts belong to the user who saved them, so an API key cannot read them.","tags":["research"],"x-cli-name":"research-drafts-get-v3","x-point11-scope":"research:read","security":[{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The study draft id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The study draft id."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchDraftsGetV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/drafts-v2/{id}":{"get":{"operationId":"research.drafts.get.v2","summary":"Get drafts (v2)","description":"Deprecated: use research.drafts.get.v3 (research_drafts_get_v3) for native audio; this version leaves audio out: a question that shows audio shows no file, and a list of files drops it. Get one of the signed-in user's saved Research study drafts by id: its revision and the unfinished study document (name, material, questions and the file or video each shows, schedule, audience). Drafts belong to the user who saved them, so an API key cannot read them.","deprecated":true,"tags":["research"],"x-cli-name":"research-drafts-get-v2","x-point11-scope":"research:read","security":[{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The study draft id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The study draft id."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchDraftsGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/drafts/{id}":{"get":{"operationId":"research.drafts.get.v1","summary":"Get drafts","description":"Deprecated: use research.drafts.get.v2 (research_drafts_get_v2), which also names a study video; this version leaves every video out, so a question that shows one reads as showing no file and a list of files omits it. Get one of the signed-in user's saved Research study drafts by id: its revision and the unfinished study document (name, material, questions, schedule, audience). Drafts belong to the user who saved them, so an API key cannot read them.","deprecated":true,"tags":["research"],"x-cli-name":"research-drafts-get","x-point11-scope":"research:read","security":[{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The study draft id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The study draft id."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchDraftsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/drafts/save-v3":{"post":{"operationId":"research.drafts.save.v3","summary":"Save drafts (v3)","description":"Supports original MP3 and WAV audio alongside the existing study media. Save one of the signed-in user's unfinished Research study drafts, whose questions may each show a file or a video. Send a new draft id with revision 0 to create it, or the revision you last read to replace its document; a draft changed elsewhere since that revision is refused, never overwritten. Returns the saved revision. Drafts belong to the user who saves them, so an API key cannot save one.","tags":["research"],"x-cli-name":"research-drafts-save-v3","x-point11-scope":"research:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchDraftsSaveV3Request"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchDraftsSaveV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/drafts/save-v2":{"post":{"operationId":"research.drafts.save.v2","summary":"Save drafts (v2)","description":"Deprecated: use research.drafts.save.v3 (research_drafts_save_v3) for native audio; this version takes no audio and refuses to replace a stored draft that holds audio (409 PRECONDITION_FAILED, details.reason audio_attachment), since it replaces the whole document. Save one of the signed-in user's unfinished Research study drafts, whose questions may each show a file or a video. Send a new draft id with revision 0 to create it, or the revision you last read to replace its document; a draft changed elsewhere since that revision is refused, never overwritten. Returns the saved revision. Drafts belong to the user who saves them, so an API key cannot save one.","deprecated":true,"tags":["research"],"x-cli-name":"research-drafts-save-v2","x-point11-scope":"research:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchDraftsSaveV2Request"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchDraftsSaveV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/drafts/save":{"post":{"operationId":"research.drafts.save.v1","summary":"Save drafts","description":"Deprecated: use research.drafts.save.v2 (research_drafts_save_v2), which also takes a study video; this version takes none, leaves every video out of the document it returns, and refuses to save over a stored draft that holds one (409 PRECONDITION_FAILED, details.reason video_attachment), since replacing the document would remove it. Save one of the signed-in user's unfinished Research study drafts. Send a new draft id with revision 0 to create it, or the revision you last read to replace its document; a draft changed elsewhere since that revision is refused, never overwritten. Returns the saved revision. Drafts belong to the user who saves them, so an API key cannot save one.","deprecated":true,"tags":["research"],"x-cli-name":"research-drafts-save","x-point11-scope":"research:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchDraftsSaveRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchDraftsSaveResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/drafts/delete":{"post":{"operationId":"research.drafts.delete.v1","summary":"Delete drafts","description":"Permanently delete one of the signed-in user's unfinished Research study drafts. Send the revision you last read; a draft changed elsewhere since that revision is refused and kept. A deleted draft never comes back, and its uploaded study files are not deleted with it. Drafts belong to the user who saved them, so an API key cannot delete one.","tags":["research"],"x-cli-name":"research-drafts-delete","x-point11-scope":"research:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchDraftsDeleteRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchDraftsDeleteResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/drafts/copy-v2":{"post":{"operationId":"research.drafts.copy.v2","summary":"Copy drafts (v2)","description":"Supports original MP3 and WAV audio alongside the existing study media. Copy a Research campaign's saved Custom study into a new unfinished study draft of the signed-in user's: its material and questions as the campaign froze them, its business profile, its schedule (once, weekly or monthly) and the customers on its roster as the draft's picked customers (none when the roster holds more than a draft can pick). Send a new draft id as `id` and the campaign's id as `campaignId`; the copy is that draft at revision 1, which research_drafts_get_v3 reads and research_drafts_save_v3 edits. Launching it (research_campaigns_launch) starts a new campaign, and the copied campaign stays as it ran: a one-time study runs once, so a changed study is a new one. A study other than Custom is refused 409 PRECONDITION_FAILED (details.reason not_copyable); a deleted, unknown or other tenant's campaign answers 404. Drafts belong to the user who saves them, so an API key cannot copy one.","tags":["research"],"x-cli-name":"research-drafts-copy-v2","x-point11-scope":"research:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchDraftsCopyV2Request"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchDraftsCopyV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/drafts/copy":{"post":{"operationId":"research.drafts.copy.v1","summary":"Copy drafts","description":"Deprecated: use research.drafts.copy.v2 (research_drafts_copy_v2) for native audio; this version refuses to copy a study that shows audio (409 PRECONDITION_FAILED, details.reason not_copyable). Copy a Research campaign's saved Custom study into a new unfinished draft of the signed-in user's: its material and questions as frozen, its business profile, its schedule (once, weekly or monthly) and its roster's customers as the draft's picked customers (none when the roster holds more than a draft can pick). Send a new draft id as `id` and the campaign as `campaignId`; the copy is that draft at revision 1, which research_drafts_get_v2 reads and research_drafts_save_v2 edits. Launching it (research_campaigns_launch) starts a new campaign; the copied one stays as it ran. A study other than Custom is refused 409 PRECONDITION_FAILED (details.reason not_copyable); a deleted, unknown or other tenant's campaign answers 404. Drafts belong to the user who saves them, so an API key cannot copy one.","deprecated":true,"tags":["research"],"x-cli-name":"research-drafts-copy","x-point11-scope":"research:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchDraftsCopyRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchDraftsCopyResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/results-v7/{id}":{"get":{"operationId":"research.results.get.v7","summary":"Get results (v7)","description":"Adds a creative test's structured scorecard, the study's instrument and the shown run's models. Get one Research campaign's results over a date range. Every figure counts the interviews completed on the date range's UTC days (All time: every interview), each answer counting toward a question of the campaign's current study only when its interview's study asked that question exactly so; Research's results are no time series, so nothing is read as of a day or compared with an earlier window. Answers the range (its days, interviews and customers), one card per question of the current study (the file or video it showed, figure, distribution, its headline's value with the distinct respondents it stands on, and the newest run's synthesized summary and evidence), the study's headline scorecard, and the newest run's status and coverage. Pass dateRange for the range (by default the last 90 days, widened to All time when they hold no interview), segments to narrow the figures, or runId for one saved run as it ran, with no range. A creative test that named its metrics also answers creativeScorecard: each metric of each creative keyed by its file's artifactId, every average unrounded with its distribution, spread and 95% interval; Overall over each respondent's own mean; and each creative's paired difference from the leader with its interval, stating no verdict; and how many interviews a declared backup model answered in part. instrument names the frozen study the figures read, and models the shown run's models by role: the one its assignment requested and each that answered.","tags":["research"],"x-cli-name":"research-results-get-v7","x-point11-scope":"research:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The campaign id from research.campaigns.list.v1; optional with runId, whose own campaign is read.","schema":{"description":"The campaign id from research.campaigns.list.v1; optional with runId, whose own campaign is read.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"runId","in":"query","required":false,"description":"One customer-triggered run, read as it ran; without id its own campaign is read, with id it must be that campaign's. Omit for the date range.","schema":{"description":"One customer-triggered run, read as it ran; without id its own campaign is read, with id it must be that campaign's. Omit for the date range.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"segments","in":"query","required":false,"description":"Entries from research.campaign-segments.get.v1; figures count only respondents inside them. Accepts only the audience, channel, store, customer axes; an entry on any other axis is refused as 400 INVALID_INPUT.","content":{"application/json":{"schema":{"description":"Entries from research.campaign-segments.get.v1; figures count only respondents inside them. Accepts only the audience, channel, store, customer axes; an entry on any other axis is refused as 400 INVALID_INPUT.","maxItems":50,"type":"array","items":{"type":"object","properties":{"axis":{"type":"string","enum":["audience","channel","market","age","householdIncome","education","lifeStage","areaType","companySize","buyerRole","seniority","occupation","job","triggerType","intentStage","language","gender","store","customer"]},"id":{"type":"string","minLength":1,"maxLength":512}},"required":["axis","id"],"additionalProperties":false}}}}},{"name":"dateRange","in":"query","required":false,"description":"The days the figures are read over; omit for the last 90 days, widened to All time when they hold no interview, as the dashboard's default. Ignored with runId.","content":{"application/json":{"schema":{"description":"The days the figures are read over; omit for the last 90 days, widened to All time when they hold no interview, as the dashboard's default. Ignored with runId.","type":"object","properties":{"from":{"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}],"description":"The range's first UTC day; null for All time, from the first interview."},"to":{"description":"The range's last UTC day; omit for today. A day past today reads to today.","type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"widenWhenEmpty":{"description":"Read All time when the range holds none of the campaign's interviews, as the dashboard's default range does; an explicit range is never widened.","type":"boolean"}},"required":["from"],"additionalProperties":false}}}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchResultsGetV7Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/results-v6/{id}":{"get":{"operationId":"research.results.get.v6","summary":"Get results (v6)","description":"Deprecated: use research.results.get.v7 (research_results_get_v7), which also answers a creative test's structured scorecard, the study's instrument and the shown run's models; this version answers the same results without them. Get one Research campaign's results over a date range. Every figure counts the interviews completed on the date range's UTC days (All time: every interview), each answer counting toward a question of the campaign's current study only when its interview's study asked that question exactly so; Research's results are no time series, so nothing is read as of a day or compared with an earlier window. Answers the range (its days, interviews and customers), one card per question of the current study (the file or video it showed, figure, distribution, its headline's value with the distinct respondents it stands on, and the newest run's synthesized summary and evidence), the study's headline scorecard, and the newest run's status and coverage. Pass dateRange for the range (by default the last 90 days, widened to All time when they hold no interview), segments to narrow the figures, or runId for one saved run as it ran, with no range.","deprecated":true,"tags":["research"],"x-cli-name":"research-results-get-v6","x-point11-scope":"research:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The campaign id from research.campaigns.list.v1; optional with runId, whose own campaign is read.","schema":{"description":"The campaign id from research.campaigns.list.v1; optional with runId, whose own campaign is read.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"runId","in":"query","required":false,"description":"One customer-triggered run, read as it ran; without id its own campaign is read, with id it must be that campaign's. Omit for the date range.","schema":{"description":"One customer-triggered run, read as it ran; without id its own campaign is read, with id it must be that campaign's. Omit for the date range.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"segments","in":"query","required":false,"description":"Entries from research.campaign-segments.get.v1; figures count only respondents inside them. Accepts only the audience, channel, store, customer axes; an entry on any other axis is refused as 400 INVALID_INPUT.","content":{"application/json":{"schema":{"description":"Entries from research.campaign-segments.get.v1; figures count only respondents inside them. Accepts only the audience, channel, store, customer axes; an entry on any other axis is refused as 400 INVALID_INPUT.","maxItems":50,"type":"array","items":{"type":"object","properties":{"axis":{"type":"string","enum":["audience","channel","market","age","householdIncome","education","lifeStage","areaType","companySize","buyerRole","seniority","occupation","job","triggerType","intentStage","language","gender","store","customer"]},"id":{"type":"string","minLength":1,"maxLength":512}},"required":["axis","id"],"additionalProperties":false}}}}},{"name":"dateRange","in":"query","required":false,"description":"The days the figures are read over; omit for the last 90 days, widened to All time when they hold no interview, as the dashboard's default. Ignored with runId.","content":{"application/json":{"schema":{"description":"The days the figures are read over; omit for the last 90 days, widened to All time when they hold no interview, as the dashboard's default. Ignored with runId.","type":"object","properties":{"from":{"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}],"description":"The range's first UTC day; null for All time, from the first interview."},"to":{"description":"The range's last UTC day; omit for today. A day past today reads to today.","type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"widenWhenEmpty":{"description":"Read All time when the range holds none of the campaign's interviews, as the dashboard's default range does; an explicit range is never widened.","type":"boolean"}},"required":["from"],"additionalProperties":false}}}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchResultsGetV6Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/results-v5/{id}":{"get":{"operationId":"research.results.get.v5","summary":"Get results (v5)","description":"Deprecated: use research.results.get.v7 (research_results_get_v7) for native audio; this version leaves audio out: a question card that showed audio shows no file. Get one Research campaign's results over a date range. Every figure counts the interviews completed on the range's UTC days (All time: every interview), an answer counting toward a question of the current study only when its interview's study asked that question exactly so; results are no time series, so nothing is read as of a day or compared with an earlier window. Answers the range (its days, interviews and customers), one card per question of the current study (the file or video it showed, figure, distribution, headline value with the distinct respondents behind it, the newest run's summary and evidence), the study's headline scorecard, and the newest run's status and coverage. Pass dateRange (by default the last 90 days, widened to All time when they hold no interview), segments to narrow the figures, or runId for one saved run as it ran, with no range.","deprecated":true,"tags":["research"],"x-cli-name":"research-results-get-v5","x-point11-scope":"research:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The campaign id from research.campaigns.list.v1; optional with runId, whose own campaign is read.","schema":{"description":"The campaign id from research.campaigns.list.v1; optional with runId, whose own campaign is read.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"runId","in":"query","required":false,"description":"One customer-triggered run, read as it ran; without id its own campaign is read, with id it must be that campaign's. Omit for the date range.","schema":{"description":"One customer-triggered run, read as it ran; without id its own campaign is read, with id it must be that campaign's. Omit for the date range.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"segments","in":"query","required":false,"description":"Entries from research.campaign-segments.get.v1; figures count only respondents inside them. Accepts only the audience, channel, store, customer axes; an entry on any other axis is refused as 400 INVALID_INPUT.","content":{"application/json":{"schema":{"description":"Entries from research.campaign-segments.get.v1; figures count only respondents inside them. Accepts only the audience, channel, store, customer axes; an entry on any other axis is refused as 400 INVALID_INPUT.","maxItems":50,"type":"array","items":{"type":"object","properties":{"axis":{"type":"string","enum":["audience","channel","market","age","householdIncome","education","lifeStage","areaType","companySize","buyerRole","seniority","occupation","job","triggerType","intentStage","language","gender","store","customer"]},"id":{"type":"string","minLength":1,"maxLength":512}},"required":["axis","id"],"additionalProperties":false}}}}},{"name":"dateRange","in":"query","required":false,"description":"The days the figures are read over; omit for the last 90 days, widened to All time when they hold no interview, as the dashboard's default. Ignored with runId.","content":{"application/json":{"schema":{"description":"The days the figures are read over; omit for the last 90 days, widened to All time when they hold no interview, as the dashboard's default. Ignored with runId.","type":"object","properties":{"from":{"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}],"description":"The range's first UTC day; null for All time, from the first interview."},"to":{"description":"The range's last UTC day; omit for today. A day past today reads to today.","type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"widenWhenEmpty":{"description":"Read All time when the range holds none of the campaign's interviews, as the dashboard's default range does; an explicit range is never widened.","type":"boolean"}},"required":["from"],"additionalProperties":false}}}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchResultsGetV5Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/results/export-v3":{"get":{"operationId":"research.results.export.v3","summary":"Export results (v3)","description":"Deprecated: use reports.report-tables.export.v1 (reports_report_tables_export), which exports a report of research.answers over a date range (each question's answers by share, answers, respondents and a rating question's average, everyone's or across one segment axis), counted by the same read; only this version reads one saved run (runId) or narrows by segments, and adds each question's type, a ranking's average rank and the headline. This version stays served as published. Export one Research campaign's results as CSV, as the results page draws them: one line per answer row of each question (options most chosen first, a ranking's best average rank first, a scale's points highest first, a paragraph's tones, a computer task's completion), each with the question's number, text, type and responses, the row's share, a ranking's average rank, a scale's average and the question's headline figure, counted as research_results_get_v7 counts them. Answers the whole file inline as `content`. Pass from and to for the date range (by default the last 90 days, widened to All time when they hold no interview), runId for one saved run as it ran, and segments to narrow the figures, as research_results_get_v7 takes them.","deprecated":true,"tags":["research"],"x-cli-name":"research-results-export-v3","x-point11-scope":"research:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"query","required":false,"description":"The campaign id from research.campaigns.list.v1; optional with runId, whose own campaign is read.","schema":{"description":"The campaign id from research.campaigns.list.v1; optional with runId, whose own campaign is read.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"runId","in":"query","required":false,"description":"One customer-triggered run, read as it ran; without id its own campaign is read, with id it must be that campaign's. Omit for the date range.","schema":{"description":"One customer-triggered run, read as it ran; without id its own campaign is read, with id it must be that campaign's. Omit for the date range.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"segments","in":"query","required":false,"description":"Entries from research.campaign-segments.get.v1 as `axis:id`; figures count only respondents inside them. Accepts only the audience, channel, store, customer axes; an entry on any other axis is refused as 400 INVALID_INPUT.","schema":{"description":"Entries from research.campaign-segments.get.v1 as `axis:id`; figures count only respondents inside them. Accepts only the audience, channel, store, customer axes; an entry on any other axis is refused as 400 INVALID_INPUT.","maxItems":50,"type":"array","items":{"type":"string","maxLength":600}}},{"name":"from","in":"query","required":false,"description":"The date range's first UTC day; omit both from and to for the last 90 days, widened to All time when they hold no interview, or from alone for All time.","schema":{"description":"The date range's first UTC day; omit both from and to for the last 90 days, widened to All time when they hold no interview, or from alone for All time.","type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"}},{"name":"to","in":"query","required":false,"description":"The date range's last UTC day; omit for today.","schema":{"description":"The date range's last UTC day; omit for today.","type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchResultsExportV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/results/export-v2":{"get":{"operationId":"research.results.export.v2","summary":"Export results (v2)","description":"Deprecated: use reports.report-tables.export.v1 (reports_report_tables_export), which exports a report of research.answers counted by the same read. This version exports research.results.get.v5's read with its published columns: its two change columns are always empty, since a range compares with nothing. Export one Research campaign's results as CSV, as the results page draws them under the same scope, one line per answer row of each question. Answers the whole file inline as `content`. Pass from and to for the date range, runId for one saved run, and segments to narrow the figures.","deprecated":true,"tags":["research"],"x-cli-name":"research-results-export-v2","x-point11-scope":"research:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"query","required":false,"description":"The campaign id from research.campaigns.list.v1; optional with runId, whose own campaign is read.","schema":{"description":"The campaign id from research.campaigns.list.v1; optional with runId, whose own campaign is read.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"runId","in":"query","required":false,"description":"One customer-triggered run, read as it ran; without id its own campaign is read, with id it must be that campaign's. Omit for the date range.","schema":{"description":"One customer-triggered run, read as it ran; without id its own campaign is read, with id it must be that campaign's. Omit for the date range.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"segments","in":"query","required":false,"description":"Entries from research.campaign-segments.get.v1 as `axis:id`; figures count only respondents inside them. Accepts only the audience, channel, store, customer axes; an entry on any other axis is refused as 400 INVALID_INPUT.","schema":{"description":"Entries from research.campaign-segments.get.v1 as `axis:id`; figures count only respondents inside them. Accepts only the audience, channel, store, customer axes; an entry on any other axis is refused as 400 INVALID_INPUT.","maxItems":50,"type":"array","items":{"type":"string","maxLength":600}}},{"name":"from","in":"query","required":false,"description":"The date range's first UTC day; omit both from and to for the last 90 days, widened to All time when they hold no interview, or from alone for All time.","schema":{"description":"The date range's first UTC day; omit both from and to for the last 90 days, widened to All time when they hold no interview, or from alone for All time.","type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"}},{"name":"to","in":"query","required":false,"description":"The date range's last UTC day; omit for today.","schema":{"description":"The date range's last UTC day; omit for today.","type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchResultsExportV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/results/export":{"get":{"operationId":"research.results.export.v1","summary":"Export results","description":"Deprecated: use reports.report-tables.export.v1 (reports_report_tables_export), which exports a report of research.answers counted by the same read over any date range. This version exports research.results.get.v5's default read with its published columns: its lead figure names an open question's score alone and its change column is always empty, since a range compares with nothing. Export one Research campaign's results as CSV, as the results page draws them under the same scope, one line per answer row of each question. Answers the whole file inline as `content`. Pass runId for one saved run, and segments to narrow the figures.","deprecated":true,"tags":["research"],"x-cli-name":"research-results-export","x-point11-scope":"research:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"query","required":false,"description":"The campaign id from research.campaigns.list.v1; optional with runId, whose own campaign is read.","schema":{"description":"The campaign id from research.campaigns.list.v1; optional with runId, whose own campaign is read.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"runId","in":"query","required":false,"description":"One customer-triggered run, read as it ran; without id its own campaign is read, with id it must be that campaign's. Omit for the date range.","schema":{"description":"One customer-triggered run, read as it ran; without id its own campaign is read, with id it must be that campaign's. Omit for the date range.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"segments","in":"query","required":false,"description":"Entries from research.campaign-segments.get.v1 as `axis:id`; figures count only respondents inside them. Accepts only the audience, channel, store, customer axes; an entry on any other axis is refused as 400 INVALID_INPUT.","schema":{"description":"Entries from research.campaign-segments.get.v1 as `axis:id`; figures count only respondents inside them. Accepts only the audience, channel, store, customer axes; an entry on any other axis is refused as 400 INVALID_INPUT.","maxItems":50,"type":"array","items":{"type":"string","maxLength":600}}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchResultsExportResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/result-segments-v4/{id}":{"get":{"operationId":"research.result-segments.get.v4","summary":"Get result segments (v4)","description":"Get one Research campaign's results campaign-wide and under each audience, channel, store, product (revenue line), tone and topic entry: for every question research_results_get_v7 shows, in study order, the campaign-wide figure and each entry's, counted as research_results_get_v7 counts it with that entry as `segments` (answers, distinct respondents, slices, lead figure, a scale's average). Entries are the audiences, channels and stores research_campaign_segments_get lists (same ids and labels), then the products the campaign's customers carry, each with the most answers any question counted under it; a respondent counts under the entries of the customer version they answered as. Pass dateRange as research_results_get_v7 takes it, or runId for one saved run as it ran; axis reads one axis's entries, each counted as in the full read. Another organization's campaign or run is not found.","tags":["research"],"x-cli-name":"research-result-segments-get-v4","x-point11-scope":"research:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The campaign id from research.campaigns.list.v1.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The campaign id from research.campaigns.list.v1."}},{"name":"runId","in":"query","required":false,"description":"One of the campaign's customer-triggered runs, read as it ran. Omit for the date range.","schema":{"description":"One of the campaign's customer-triggered runs, read as it ran. Omit for the date range.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"dateRange","in":"query","required":false,"description":"The days the figures are read over, as research.results.get.v5 takes them; omit for the last 90 days, widened to All time when they hold no interview. Ignored with runId.","content":{"application/json":{"schema":{"description":"The days the figures are read over, as research.results.get.v5 takes them; omit for the last 90 days, widened to All time when they hold no interview. Ignored with runId.","type":"object","properties":{"from":{"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}],"description":"The range's first UTC day; null for All time, from the first interview."},"to":{"description":"The range's last UTC day; omit for today. A day past today reads to today.","type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"widenWhenEmpty":{"description":"Read All time when the range holds none of the campaign's interviews, as the dashboard's default range does; an explicit range is never widened.","type":"boolean"}},"required":["from"],"additionalProperties":false}}}},{"name":"axis","in":"query","required":false,"description":"One axis: its entries alone, each figure exactly as the read of every axis counts it. Omit for every axis.","schema":{"description":"One axis: its entries alone, each figure exactly as the read of every axis counts it. Omit for every axis.","type":"string","enum":["audience","channel","store","product","sentiment","topic"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchResultSegmentsGetV4Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/result-segment-axes-v2/{id}":{"get":{"operationId":"research.result-segment-axes.get.v2","summary":"Get result segment axes (v2)","description":"Get which axes one Research campaign's results breakdown (research_result_segments_get_v4) lists an entry on, without counting a figure: audience, channel, store and product (revenue line) when the campaign's customers carry one, and tone and topic when the respondents of the range from to to (the days research_results_get_v7's range names) take one, read from every accepted answer of those days, so after a study's edit a tone or topic can come from answers to the earlier study alone. Omit from and to before the campaign's first interview to read the customers' axes alone. A campaign your organization does not own is not found.","tags":["research"],"x-cli-name":"research-result-segment-axes-get-v2","x-point11-scope":"research:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The campaign id from research.campaigns.list.v1.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The campaign id from research.campaigns.list.v1."}},{"name":"from","in":"query","required":false,"description":"The range's first UTC day, as research.results.get.v5's range names it: tones and topics are read over its days. Omit it and to before the campaign's first interview.","schema":{"description":"The range's first UTC day, as research.results.get.v5's range names it: tones and topics are read over its days. Omit it and to before the campaign's first interview.","type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"}},{"name":"to","in":"query","required":false,"description":"The range's last UTC day, as research.results.get.v5's range names it.","schema":{"description":"The range's last UTC day, as research.results.get.v5's range names it.","type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchResultSegmentAxesGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/runs/{id}":{"get":{"operationId":"research.runs.get.v1","summary":"Get runs","description":"Get one customer-triggered Research run by id: the campaign and study it ran. Read its results with research_results_get_v7 with this runId.","tags":["research"],"x-cli-name":"research-runs-get","x-point11-scope":"research:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The run id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The run id."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchRunsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/runs/reanalyze":{"post":{"operationId":"research.runs.reanalyze.v1","summary":"Reanalyze runs","description":"Re-run the analysis of one failed Research run of a one-time study whose interviews were analyzed but whose insights were never published. A new run reads the failed run's saved interviews and their extracts and writes the study's insights again; it asks no interview again and adds no interview charge. Pass the failed run's id (or a failed re-run's). A run still running, one whose analysis did not fail, a recurring study's run, a study with a computer task, and a run that saved no analyzed interview are refused 409 PRECONDITION_FAILED with details.reason; a run already being re-run is refused with the re-run's id. Returns the new run; follow it with platform_runs_get_v2 and read its results with research_results_get_v7.","tags":["research"],"x-cli-name":"research-runs-reanalyze","x-point11-scope":"research:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchRunsReanalyzeRequest"}}}},"responses":{"202":{"description":"Accepted: the durable run started. Follow it with `GET /api/v1/platform/runs-v2/{id}`.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchRunsReanalyzeResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/backtests/{id}":{"get":{"operationId":"research.backtests.get.v1","summary":"Get backtests","description":"Get one Research backtest's calibration: the situation every twin read, the study's single-choice questions, which one asks the decision and how much of usual buying each of its options keeps (the member's mapping), the outcome the member recorded, and every run of the study: what it asked (its respondent models and any context its twins read after the situation), how many twins chose each option, the forecast change those answers add up to with its 95% range, how far it stands from the outcome in points, whether both moved the same way and the range holds the outcome, and the share of answers it holds in common with the first run. Also how many twins a rerun would ask. A campaign that is no backtest is refused 404. `id` is the campaign's id.","tags":["research"],"x-cli-name":"research-backtests-get","x-point11-scope":"research:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The backtest's campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The backtest's campaign id."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchBacktestsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/backtest-mappings/update":{"post":{"operationId":"research.backtest-mappings.update.v1","summary":"Update backtest mappings","description":"Set which single-choice question of a Research backtest asks the decision, and how much of a customer's usual buying each of its options keeps, by the option's position: 0 stops buying, 1 keeps it, up to 2 buys more, and null leaves that option's answers out of the forecast. Replaces the backtest's mapping; no twin reads it. `id` is the campaign's id.","tags":["research"],"x-cli-name":"research-backtest-mappings-update","x-point11-scope":"research:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchBacktestMappingsUpdateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchBacktestMappingsUpdateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/backtest-outcomes/update":{"post":{"operationId":"research.backtest-outcomes.update.v1","summary":"Update backtest outcomes","description":"Record what really happened after the decision a Research backtest re-asks: what was measured, its change as a fraction (-0.3 is a 30% drop), and an optional note; or pass outcome null to clear it. Replaces the recorded outcome; no twin reads it. `id` is the campaign's id.","tags":["research"],"x-cli-name":"research-backtest-outcomes-update","x-point11-scope":"research:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchBacktestOutcomesUpdateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchBacktestOutcomesUpdateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/backtests/rerun-v2":{"post":{"operationId":"research.backtests.rerun.v2","summary":"Rerun backtests (v2)","description":"Run a Research backtest again on the twins its first run asked: on another respondent model, with customer assumptions added for its twins, or both. Added assumptions are statements every twin of that run takes as true of themselves beside the study's own (at most 10 in all, each at most 2,000 characters), screened as a launch's study is. Every interview is billed as delivered usage, as any study's. Refused 409 PRECONDITION_FAILED until the first run has finished. Returns the new run; follow it with platform_runs_get_v2 and compare it with research_backtests_get. `id` is the campaign's id.","tags":["research"],"x-cli-name":"research-backtests-rerun-v2","x-point11-scope":"research:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchBacktestsRerunV2Request"}}}},"responses":{"202":{"description":"Accepted: the durable run started. Follow it with `GET /api/v1/platform/runs-v2/{id}`.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchBacktestsRerunV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/backtests/rerun":{"post":{"operationId":"research.backtests.rerun.v1","summary":"Rerun backtests","description":"Deprecated: use research.backtests.rerun.v2 (research_backtests_rerun_v2), which adds customer assumptions for the twins in place of context they read after the situation; this version adds its context as one customer assumption, so a context longer than 2,000 characters is refused. Run a Research backtest again on the twins its first run asked: on another respondent model, with context for the twins, or both. Context is screened as a launch's study is. Every interview is billed as delivered usage, as any study's. Refused 409 PRECONDITION_FAILED until the first run has finished. Returns the new run; follow it with platform_runs_get_v2 and compare it with research_backtests_get. `id` is the campaign's id.","deprecated":true,"tags":["research"],"x-cli-name":"research-backtests-rerun","x-point11-scope":"research:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchBacktestsRerunRequest"}}}},"responses":{"202":{"description":"Accepted: the durable run started. Follow it with `GET /api/v1/platform/runs-v2/{id}`.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchBacktestsRerunResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/studies/prefill":{"post":{"operationId":"research.studies.prefill.v1","summary":"Prefill studies","description":"Fill the blanks a draft Research study still has (bracketed words in its questions, empty option rows, blank material fields, a computer task's start page or success criteria) from a business profile, using Alpha. Typed values are never slots. Returns the fills to write into the draft; it charges the organization's Alpha credits. Fills belong to the signed-in user's draft, so an API key cannot request them.","tags":["research"],"x-cli-name":"research-studies-prefill","x-point11-scope":"research:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchStudiesPrefillRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchStudiesPrefillResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/creative-tests/start":{"post":{"operationId":"research.creative-tests.start.v1","summary":"Start creative tests","description":"Test a creative with an exact selected customer-version roster: interpret the creative, then launch one ordinary Research campaign. Name the creative by attachments uploaded with research.study-attachments (images, PDFs, text, MP3 or WAV audio, MP4 or WebM video), or, as a signed-in member, by the artifactId of a Studio creative or package, whose files Research imports under this request. First impressions use natural baseline reactions; buying scenarios prepare separate explicit situational context for every selected person before launch. Name metrics to rate every creative on each of them with one question on one shared scale, which the results' scorecard compares, and platforms to show the creative as people would meet it there. Preparation calls use Alpha credits and interviews use Research. With artifactId, brief is what to learn, in the member's words; Research names the creative by its title. Before anything is paid for, the start refuses an audience or seller it cannot use, more customers than a study interviews, files past a study's attachment bound, and an organization whose plan would refuse the test's interviews (research_creative_test_quotes_get answers the same first); pass that quote's expectedPrice to refuse a start whose interview price changed since. A same-key retry of an admitted test answers it with the exact frozen selection and imported files, without reading the creative again; read research_creative_tests_get_v2 for progress and research_results_get_v7 for the launched run's results.","tags":["research"],"x-cli-name":"research-creative-tests-start","x-point11-scope":"research:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchCreativeTestsStartRequest"}}}},"responses":{"202":{"description":"Accepted: the durable run started. Follow it with `GET /api/v1/platform/runs-v2/{id}`.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchCreativeTestsStartResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/creative-tests-v2/{id}":{"get":{"operationId":"research.creative-tests.get.v2","summary":"Get creative tests (v2)","description":"Read this caller's creative test by its start request's Idempotency-Key, without generating more work: its exact selection, shared interpretation, preparation counts and the progress of the ordinary Research run it launched, and also why it failed (failure: the stage, design, preparation, launch or interviews, and its code; a launch refused by Billing names Billing's reason, and message says it in Billing's words), every creative it froze by digest (a video by its source's and its storyboard's), the exact roster with each person's snapshot hash, the seller profile version, the Designer's measures (the question that rates each metric of each creative), each participant's preparation and its failure code, and when it started, launched and ended. Once launched, campaignId and runId name that run's results; cancel a launched test by deleting its campaign with campaigns_lifecycles_delete. Only the caller that started a test reads it; list yours with research_creative_tests_list.","tags":["research"],"x-cli-name":"research-creative-tests-get-v2","x-point11-scope":"research:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The start request's Idempotency-Key.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The start request's Idempotency-Key."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchCreativeTestsGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/creative-tests/{id}":{"get":{"operationId":"research.creative-tests.get.v1","summary":"Get creative tests","description":"Deprecated: use research.creative-tests.get.v2 (research_creative_tests_get_v2), which also names why a test failed, what it froze and each participant's preparation. Read this caller's creative test by its start request's Idempotency-Key: its exact selection, shared interpretation, preparation counts and the progress of the ordinary Research run it launched, without generating more work. Once launched, campaignId and runId name that run's results.","deprecated":true,"tags":["research"],"x-cli-name":"research-creative-tests-get","x-point11-scope":"research:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The start request's Idempotency-Key.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The start request's Idempotency-Key."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchCreativeTestsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/creative-tests":{"get":{"operationId":"research.creative-tests.list.v1","summary":"List creative tests","description":"List this caller's creative tests, newest first, a page at a time: each test's start request Idempotency-Key (what research_creative_tests_get_v2 reads it by), its preparation run, name and status, and, once launched, the campaign and run research_results_get_v7 reads. An API key lists the tests it started and a member theirs; another caller's tests are not listed. Page with nextCursor.","tags":["research"],"x-cli-name":"research-creative-tests-list","x-point11-scope":"research:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Tests per page (default 20, max 100).","schema":{"description":"Tests per page (default 20, max 100).","type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","required":false,"description":"Opaque nextCursor from a previous call; the page continues after the last test that call listed.","schema":{"description":"Opaque nextCursor from a previous call; the page continues after the last test that call listed.","type":"string","minLength":1,"maxLength":256}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchCreativeTestsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/creative-test-quotes/{id}":{"get":{"operationId":"research.creative-test-quotes.get.v1","summary":"Get creative test quotes","description":"Quote a creative test's interviews before starting it (id \"organization\"), generating no work: the interviews it would run (one per selected person, whatever the number of creatives), the organization's interview price and subtotal, the catalog row and version that priced them, and Billing's answer to that batch now (included in the plan, overage, or refused in Billing's words). It refuses what research_creative_tests_start would refuse first (an audience or seller it cannot use, more customers than a study interviews). The Designer's and each participant's preparation draw Alpha credits at their exact model cost, settled after delivery and never estimated here. Pass expectedPrice to research_creative_tests_start to refuse the start if the price changes.","tags":["research"],"x-cli-name":"research-creative-test-quotes-get","x-point11-scope":"research:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Always \"organization\".","schema":{"type":"string","const":"organization","description":"Always \"organization\"."}},{"name":"audience","in":"query","required":true,"description":"The audience research_creative_tests_start would name.","content":{"application/json":{"schema":{"type":"object","properties":{"audienceProfileId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"targetedGroupIds":{"anyOf":[{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"type":"null"}]},"targetedCustomerIds":{"anyOf":[{"minItems":1,"maxItems":1000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"type":"null"}]},"targetInterviewCount":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["audienceProfileId","targetedGroupIds","targetedCustomerIds","targetInterviewCount"],"additionalProperties":false,"description":"The audience research_creative_tests_start would name."}}}},{"name":"sellerProfileId","in":"query","required":false,"description":"The seller profile the start would name; omit or null for none.","schema":{"description":"The seller profile the start would name; omit or null for none.","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchCreativeTestQuotesGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/study-designs/start-v3":{"post":{"operationId":"research.study-designs.start.v3","summary":"Start study designs (v3)","description":"Supports original MP3 and WAV audio alongside the existing study media. Prepare a custom Research instrument from creative files and a brief as a member or organization API key. Supply profileId for grounded business context, or null for creative-only feedback, and optionally contentLanguage (the profile's language when omitted). Unknown needs and buying situations remain assumptions. Returns a durable design run; read research_study_designs_get_v3 with the same Idempotency-Key. Uses the existing Alpha credit allowance. This operation prepares the study; research_campaigns_launch executes its interviews.","tags":["research"],"x-cli-name":"research-study-designs-start-v3","x-point11-scope":"research:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchStudyDesignsStartV3Request"}}}},"responses":{"202":{"description":"Accepted: the durable run started. Follow it with `GET /api/v1/platform/runs-v2/{id}`.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchStudyDesignsStartV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/study-designs-v3/{id}":{"get":{"operationId":"research.study-designs.get.v3","summary":"Get study designs (v3)","description":"Supports original MP3 and WAV audio alongside the existing study media. Read the instrument or honest unsupported outcome prepared by this member or API key under its study-design request Idempotency-Key. Returns pending, ready, or failed without another model call. A different caller's design is not found.","tags":["research"],"x-cli-name":"research-study-designs-get-v3","x-point11-scope":"research:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The Idempotency-Key of the research.study-designs.start request.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The Idempotency-Key of the research.study-designs.start request."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchStudyDesignsGetV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/study-designs/start-v2":{"post":{"operationId":"research.study-designs.start.v2","summary":"Start study designs (v2)","description":"Deprecated: use research.study-designs.start.v3 (research_study_designs_start_v3) for native audio; this version takes no audio and leaves audio out of the design it answers. Design a custom Research study from a conversation with Alpha: send the brief so far (the last message is the user's), any study files or videos already uploaded with research_study_attachments_reserve_upload_v2, and the draft's name, goal and questions. Returns the run and either the design (Alpha's reply and a complete editable study, or no study when the brief cannot become one) or pending; poll research_study_designs_get_v2 with this request's Idempotency-Key. It charges the organization's Alpha credits. Designs belong to the signed-in user's draft, so an API key cannot start one.","deprecated":true,"tags":["research"],"x-cli-name":"research-study-designs-start-v2","x-point11-scope":"research:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchStudyDesignsStartV2Request"}}}},"responses":{"202":{"description":"Accepted: the durable run started. Follow it with `GET /api/v1/platform/runs-v2/{id}`.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchStudyDesignsStartV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/study-designs/start":{"post":{"operationId":"research.study-designs.start.v1","summary":"Start study designs","description":"Deprecated: use research.study-designs.start.v2 (research_study_designs_start_v2), which also takes a study video; this version takes none and leaves a video out of the study it returns. Design a custom Research study from a conversation with Alpha: send the brief so far (the last message is the user's), any study files already uploaded with research.study-attachments, and the draft's name, goal and questions. Returns the run and either the design (Alpha's reply and a complete editable study, or no study when the brief cannot become one) or pending; poll research.study-designs.get.v1 with this request's Idempotency-Key. It charges the organization's Alpha credits. Designs belong to the signed-in user's draft, so an API key cannot start one.","deprecated":true,"tags":["research"],"x-cli-name":"research-study-designs-start","x-point11-scope":"research:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchStudyDesignsStartRequest"}}}},"responses":{"202":{"description":"Accepted: the durable run started. Follow it with `GET /api/v1/platform/runs-v2/{id}`.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchStudyDesignsStartResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/study-designs-v2/{id}":{"get":{"operationId":"research.study-designs.get.v2","summary":"Get study designs (v2)","description":"Deprecated: use research.study-designs.get.v3 (research_study_designs_get_v3) for native audio; this version leaves audio out: a question that shows audio shows no file. Get a Research study design the signed-in user started, by the Idempotency-Key of its research_study_designs_start_v2 request: pending, failed, or ready with Alpha's reply and the study. Reading makes no model call. A key that started no design of yours is not found.","deprecated":true,"tags":["research"],"x-cli-name":"research-study-designs-get-v2","x-point11-scope":"research:read","security":[{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The Idempotency-Key of the research.study-designs.start request.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The Idempotency-Key of the research.study-designs.start request."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchStudyDesignsGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/study-designs/{id}":{"get":{"operationId":"research.study-designs.get.v1","summary":"Get study designs","description":"Deprecated: use research.study-designs.get.v2 (research_study_designs_get_v2), which also names a question's video; this version leaves a video out, so a question that shows one reads as showing no file. Get a Research study design the signed-in user started, by the Idempotency-Key of its research.study-designs.start request: pending, failed, or ready with Alpha's reply and the study. Reading makes no model call. A key that started no design of yours is not found.","deprecated":true,"tags":["research"],"x-cli-name":"research-study-designs-get","x-point11-scope":"research:read","security":[{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The Idempotency-Key of the research.study-designs.start request.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The Idempotency-Key of the research.study-designs.start request."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchStudyDesignsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/study-previews-v3/{id}":{"get":{"operationId":"research.study-previews.get.v3","summary":"Get study previews (v3)","description":"Supports original MP3 and WAV audio alongside the existing study media. Preview the questions a saved Research study draft would ask, built by the same template launch uses from the material the editor stored with the draft. Save the draft with research_drafts_save_v3 first. Drafts belong to the user who saved them, so an API key cannot preview them.","tags":["research"],"x-cli-name":"research-study-previews-get-v3","x-point11-scope":"research:read","security":[{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The saved study draft to preview.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The saved study draft to preview."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchStudyPreviewsGetV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/study-previews-v2/{id}":{"get":{"operationId":"research.study-previews.get.v2","summary":"Get study previews (v2)","description":"Deprecated: use research.study-previews.get.v3 (research_study_previews_get_v3) for native audio; this version leaves audio out: a question that shows audio shows no file. Preview the questions a saved Research study draft would ask, built by the same template launch uses from the material the editor stored with the draft. Save the draft with research_drafts_save_v2 first. Drafts belong to the user who saved them, so an API key cannot preview them.","deprecated":true,"tags":["research"],"x-cli-name":"research-study-previews-get-v2","x-point11-scope":"research:read","security":[{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The saved study draft to preview.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The saved study draft to preview."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchStudyPreviewsGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/study-previews/{id}":{"get":{"operationId":"research.study-previews.get.v1","summary":"Get study previews","description":"Deprecated: use research.study-previews.get.v2 (research_study_previews_get_v2), which also names a question's video; this version leaves a video out, so a question that shows one reads as showing no file. Preview the questions a saved Research study draft would ask, built by the same template launch uses from the material the editor stored with the draft. Save the draft with research.drafts.save.v1 first. Drafts belong to the user who saved them, so an API key cannot preview them.","deprecated":true,"tags":["research"],"x-cli-name":"research-study-previews-get","x-point11-scope":"research:read","security":[{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The saved study draft to preview.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The saved study draft to preview."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchStudyPreviewsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/interview-previews/start":{"post":{"operationId":"research.interview-previews.start.v1","summary":"Start interview previews","description":"Run one sample interview of a draft Research study: one customer twin of a business profile answers the edited questions once, skipping computer tasks. For an organization already subscribed to Point11 Analytics; the sample is unbilled and never appears in campaign lists or results. Returns the sample's run; read its transcript with research_interview_previews_get_v3.","tags":["research"],"x-cli-name":"research-interview-previews-start","x-point11-scope":"research:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchInterviewPreviewsStartRequest"}}}},"responses":{"202":{"description":"Accepted: the durable run started. Follow it with `GET /api/v1/platform/runs-v2/{id}`.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchInterviewPreviewsStartResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/interview-previews-v3/{id}":{"get":{"operationId":"research.interview-previews.get.v3","summary":"Get interview previews (v3)","description":"Supports original MP3 and WAV audio alongside the existing study media. Get one sample interview by run id and business profile: its status (running, succeeded, or failed), the customer twin's name, and the transcript so far, with the file or video each question showed. A sample belongs to the user who started it, so an API key cannot read one.","tags":["research"],"x-cli-name":"research-interview-previews-get-v3","x-point11-scope":"research:read","security":[{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The sample's run id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The sample's run id."}},{"name":"businessProfileId","in":"query","required":true,"description":"The profile the sample was started on.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The profile the sample was started on."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchInterviewPreviewsGetV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/interview-previews-v2/{id}":{"get":{"operationId":"research.interview-previews.get.v2","summary":"Get interview previews (v2)","description":"Deprecated: use research.interview-previews.get.v3 (research_interview_previews_get_v3) for native audio; this version leaves audio out: a turn that showed audio shows no file. Get one sample interview by run id and business profile: its status (running, succeeded, or failed), the customer twin's name, and the transcript so far, with the file or video each question showed. A sample belongs to the user who started it, so an API key cannot read one.","deprecated":true,"tags":["research"],"x-cli-name":"research-interview-previews-get-v2","x-point11-scope":"research:read","security":[{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The sample's run id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The sample's run id."}},{"name":"businessProfileId","in":"query","required":true,"description":"The profile the sample was started on.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The profile the sample was started on."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchInterviewPreviewsGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/interview-previews/{id}":{"get":{"operationId":"research.interview-previews.get.v1","summary":"Get interview previews","description":"Deprecated: use research.interview-previews.get.v2 (research_interview_previews_get_v2), which also names a video a question showed; this version leaves a video out, so that turn reads as showing no file. Get one sample interview by run id and business profile: its status (running, succeeded, or failed), the customer twin's name, and the transcript so far. A sample belongs to the user who started it, so an API key cannot read one.","deprecated":true,"tags":["research"],"x-cli-name":"research-interview-previews-get","x-point11-scope":"research:read","security":[{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The sample's run id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The sample's run id."}},{"name":"businessProfileId","in":"query","required":true,"description":"The profile the sample was started on.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The profile the sample was started on."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchInterviewPreviewsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/campaigns/update":{"post":{"operationId":"research.campaigns.update.v1","summary":"Update campaigns","description":"Deprecated: use research.campaign-settings.update.v1 (research_campaign_settings_update), which renames a campaign with every other setting in one Save a person confirms; an API key cannot call that Save, so it keeps this rename. Rename one active or paused Research campaign; a sample interview cannot be renamed. Renaming to its current name changes nothing.","deprecated":true,"tags":["research"],"x-cli-name":"research-campaigns-update","x-point11-scope":"research:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchCampaignsUpdateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchCampaignsUpdateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/study-attachments/reserve-upload-v4":{"post":{"operationId":"research.study-attachments.reserve-upload.v4","summary":"Reserve upload study attachments (v4)","description":"Bounds a PNG, JPEG or WebP picture to 3,750,000 bytes, the most one picture carries to any model Point11 shows it to; a PDF and MP3 or WAV audio stay at 4 MiB, a plain text, Markdown or CSV file at 256 KB, and an MP4 or WebM video at 100 MiB. Reserve an organization-owned Research attachment as a member or organization API key. Declare its filename, media type and size, plus SHA-256 for every file but a video, which declares none. Upload the exact bytes using the returned presigned request, then call research_study_attachments_complete_upload_v3. The attachment records the member or API key that reserved it. Reuse the same Idempotency-Key and input after a lost response; a different caller cannot adopt the reservation.","tags":["research"],"x-cli-name":"research-study-attachments-reserve-upload-v4","x-point11-scope":"research:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchStudyAttachmentsReserveUploadV4Request"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchStudyAttachmentsReserveUploadV4Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/study-attachments/reserve-upload-v3":{"post":{"operationId":"research.study-attachments.reserve-upload.v3","summary":"Reserve upload study attachments (v3)","description":"Deprecated: use research.study-attachments.reserve-upload.v4 (research_study_attachments_reserve_upload_v4), which bounds a picture to the 3,750,000 bytes one picture carries to a model; this version admits a picture up to 4 MiB. Supports original MP3 and WAV audio alongside the existing study media. Reserve an organization-owned Research attachment as a member or organization API key. Declare its filename, media type and size, plus SHA-256 for images, PDFs, text, MP3 and WAV; MP4 or WebM videos declare no digest. Upload the exact bytes using the returned presigned request, then call research_study_attachments_complete_upload_v3. The attachment records the member or API key that reserved it. Reuse the same Idempotency-Key and input after a lost response; a different caller cannot adopt the reservation.","deprecated":true,"tags":["research"],"x-cli-name":"research-study-attachments-reserve-upload-v3","x-point11-scope":"research:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchStudyAttachmentsReserveUploadV3Request"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchStudyAttachmentsReserveUploadV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/study-attachments/reserve-upload-v2":{"post":{"operationId":"research.study-attachments.reserve-upload.v2","summary":"Reserve upload study attachments (v2)","description":"Deprecated: use research.study-attachments.reserve-upload.v3 (research_study_attachments_reserve_upload_v3) for native audio; this version takes no audio. Reserve a file to attach to a Research study question, declaring its name, media type and size: a PNG, JPEG, WebP or PDF up to 4 MiB or a plain text, Markdown or CSV file up to 256 KB, each with its SHA-256, or an MP4 or WebM video up to 100 MiB, which declares no SHA-256. Returns the attachment and one presigned upload: send the file as the body of exactly that request before it expires, then call research_study_attachments_complete_upload_v2. Attachments record the member who uploaded them, so an API key cannot reserve one.","deprecated":true,"tags":["research"],"x-cli-name":"research-study-attachments-reserve-upload-v2","x-point11-scope":"research:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchStudyAttachmentsReserveUploadV2Request"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchStudyAttachmentsReserveUploadV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/study-attachments/reserve-upload":{"post":{"operationId":"research.study-attachments.reserve-upload.v1","summary":"Reserve upload study attachments","description":"Deprecated: use research.study-attachments.reserve-upload.v2 (research_study_attachments_reserve_upload_v2), which also reserves a video; this version cannot name one. Reserve a file to attach to a Research study question (PNG, JPEG, WebP, PDF, plain text, Markdown or CSV), declaring its name, media type, size and SHA-256. Returns the attachment and one presigned upload: send the file as the body of exactly that request before it expires, then call research.study-attachments.complete-upload.v1. Attachments record the member who uploaded them, so an API key cannot reserve one.","deprecated":true,"tags":["research"],"x-cli-name":"research-study-attachments-reserve-upload","x-point11-scope":"research:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchStudyAttachmentsReserveUploadRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchStudyAttachmentsReserveUploadResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/study-attachments/complete-upload-v3":{"post":{"operationId":"research.study-attachments.complete-upload.v3","summary":"Complete upload study attachments (v3)","description":"Supports original MP3 and WAV audio alongside the existing study media. Finish a study attachment after its upload: the stored file is read back, must match the reserved size (and the reserved SHA-256, for a file or a text), and its bytes must prove its declared type. Pass the etag the upload answered, or omit it to recover from the store. Returns the attachment, ready to reference from a study question; retrying is safe. A video also returns its storyboard, which starts as preparing: read research_study_attachments_get_v2 until it is ready, refused or failed.","tags":["research"],"x-cli-name":"research-study-attachments-complete-upload-v3","x-point11-scope":"research:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchStudyAttachmentsCompleteUploadV3Request"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchStudyAttachmentsCompleteUploadV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/study-attachments/complete-upload-v2":{"post":{"operationId":"research.study-attachments.complete-upload.v2","summary":"Complete upload study attachments (v2)","description":"Deprecated: use research.study-attachments.complete-upload.v3 (research_study_attachments_complete_upload_v3) for native audio; this version refuses to finish an audio upload. Finish a study attachment after its upload: the stored file is read back, must match the reserved size (and the reserved SHA-256, for a file or a text), and its bytes must prove its declared type. Pass the etag the upload answered, or omit it to recover from the store. Returns the attachment, ready to reference from a study question; retrying is safe. A video also returns its storyboard, which starts as preparing: read research_study_attachments_get until it is ready, refused or failed.","deprecated":true,"tags":["research"],"x-cli-name":"research-study-attachments-complete-upload-v2","x-point11-scope":"research:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchStudyAttachmentsCompleteUploadV2Request"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchStudyAttachmentsCompleteUploadV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/study-attachments/complete-upload":{"post":{"operationId":"research.study-attachments.complete-upload.v1","summary":"Complete upload study attachments","description":"Deprecated: use research.study-attachments.complete-upload.v2 (research_study_attachments_complete_upload_v2), which also finishes a video; this version answers a video as not found. Finish a study attachment after its upload: the stored file is read back, must match the reserved size and SHA-256, and its bytes must prove its declared type. Pass the etag the upload answered, or omit it to recover from the store. Returns the attachment, ready to reference from a study question; retrying is safe.","deprecated":true,"tags":["research"],"x-cli-name":"research-study-attachments-complete-upload","x-point11-scope":"research:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchStudyAttachmentsCompleteUploadRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchStudyAttachmentsCompleteUploadResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/study-attachments/import-link":{"post":{"operationId":"research.study-attachments.import-link.v1","summary":"Import link study attachments","description":"Attach a study file by its link instead of uploading it: Point11 checks the link is safe, fetches the file it points to, and admits it exactly as an upload (an image or a PDF up to 4 MiB, MP3 or WAV audio up to 4 MiB, a plain text, Markdown or CSV file up to 256 KB, or an MP4 or WebM video up to 100 MiB whose server states its size). The type is the one the link's server names, else the one the file's name names, and the bytes must prove it. A web page is refused: link the file itself. Returns the attachment, ready to reference from a study question; retrying with the same Idempotency-Key answers the same file without fetching the link again. When the link's safety check cannot run, it answers 503: try again. A video also returns its storyboard, which starts as preparing: read research_study_attachments_get_v2 until it is ready, refused or failed.","tags":["research"],"x-cli-name":"research-study-attachments-import-link","x-point11-scope":"research:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchStudyAttachmentsImportLinkRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchStudyAttachmentsImportLinkResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/study-attachments/import-connected":{"post":{"operationId":"research.study-attachments.import-connected.v1","summary":"Import connected study attachments","description":"Attach a study file from one of the member's own connected apps instead of uploading it: a file in Google Drive, OneDrive or Dropbox, a Figma frame (it comes in as a PNG at up to twice its size), or a Canva design (a PNG for one page, a PDF for several, or an MP4 when its ref asks for a video). Name the app and the item's ref as alpha_connector_files_list returned it. Point11 reads it with the member's own connection and admits it exactly as an upload, converting a file a study cannot read as it is (a Google document comes in as a PDF). Returns the attachment, ready to reference from a study question; retrying with the same Idempotency-Key answers the same file without reading the app again. Connect the app in Settings, under Connections, first. A video also returns its storyboard, which starts as preparing: read research_study_attachments_get_v2 until it is ready, refused or failed.","tags":["research"],"x-cli-name":"research-study-attachments-import-connected","x-point11-scope":"research:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchStudyAttachmentsImportConnectedRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchStudyAttachmentsImportConnectedResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/study-attachments/import-artifact":{"post":{"operationId":"research.study-attachments.import-artifact.v1","summary":"Import artifact study attachments","description":"Attach the files of one Studio asset the member may read (a project's variant or a saved ad, by its artifact id) as study files, without downloading and uploading them: every file of a package comes in, from 1 up to a study's limit, each as it is stored. Returns the asset's title and the attachments, ready to reference from study questions; retrying with the same Idempotency-Key answers the same attachments. A file a study cannot hold is refused with its reason, and nothing is attached.","tags":["research"],"x-cli-name":"research-study-attachments-import-artifact","x-point11-scope":"research:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchStudyAttachmentsImportArtifactRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchStudyAttachmentsImportArtifactResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/study-attachment-sources/reserve":{"post":{"operationId":"research.study-attachment-sources.reserve.v1","summary":"Reserve study attachment sources","description":"Reserve the upload of a file Point11 converts into a study file: a picture a study cannot read as it is (GIF, HEIC or HEIF, AVIF, TIFF, BMP or SVG, or a JPEG, PNG or WebP past what reserve-upload admits), any video (MOV, M4V, MKV, AVI, MPEG, 3GP or WMV, or an MP4 or WebM of any codec), a sound (M4A or AAC, OGG or Opus, FLAC, AIFF, WebM audio or WMA, or MP3 or WAV past 4 MiB) or a document (PowerPoint, Keynote, Word, OpenDocument or RTF, or a PDF past 4 MiB). Declare its filename, media type and size: a picture at most 50 MiB, a video 500 MiB, a sound 200 MiB, a document 100 MiB. Its type is the one its name's extension names, else its declared type. Upload the exact bytes using the returned presigned request, then call research_study_attachment_sources_convert. Reuse the same Idempotency-Key and input after a lost response.","tags":["research"],"x-cli-name":"research-study-attachment-sources-reserve","x-point11-scope":"research:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchStudyAttachmentSourcesReserveRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchStudyAttachmentSourcesReserveResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/study-attachment-sources/convert":{"post":{"operationId":"research.study-attachment-sources.convert.v1","summary":"Convert study attachment sources","description":"Convert an uploaded original into the study file it becomes, and attach it: a still picture becomes a JPEG (a WebP when it has transparency) within 2,048 pixels and 3.75 MB, a moving picture or a video an H.264 MP4 a browser plays (copied as it stands when it already is one) of at most 3 minutes and 100 MiB, a sound an MP3 within 4 MiB, and slides or a document a PDF within 4 MiB. The study keeps only the converted file, named as the original with its new extension; the original is deleted. Returns the attachment, ready to reference from a study question; retrying with the same Idempotency-Key answers the same file without converting again. A video also returns its storyboard, which starts as preparing: read research_study_attachments_get_v2 until it is ready, refused or failed. A file Point11 cannot read, or one that cannot fit a study once converted, is refused with its reason.","tags":["research"],"x-cli-name":"research-study-attachment-sources-convert","x-point11-scope":"research:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchStudyAttachmentSourcesConvertRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchStudyAttachmentSourcesConvertResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/study-attachments-v2/{id}":{"get":{"operationId":"research.study-attachments.get.v2","summary":"Get study attachments (v2)","description":"Supports original MP3 and WAV audio alongside the existing study media. Get one ready study attachment by id: its filename, media type and size. A video also answers its storyboard, the timed still frames and transcript a study shows in its place: preparing, ready (with its duration, each frame's time, size and id, the transcript, and the bytes it counts toward a study's 8 MiB of attachments), refused (with the reason the file cannot be used) or failed. A refused or failed video is replaced by uploading it again. Read a frame's picture with research_study_attachments_download by the frame's id.","tags":["research"],"x-cli-name":"research-study-attachments-get-v2","x-point11-scope":"research:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The study attachment id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The study attachment id."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchStudyAttachmentsGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/study-attachments/{id}":{"get":{"operationId":"research.study-attachments.get.v1","summary":"Get study attachments","description":"Deprecated: use research.study-attachments.get.v2 (research_study_attachments_get_v2) for native audio; this version does not find an audio attachment. Get one ready study attachment by id: its filename, media type and size. A video also answers its storyboard, the timed still frames and transcript a study shows in its place: preparing, ready (with its duration, each frame's time, size and id, the transcript, and the bytes it counts toward a study's 8 MiB of attachments), refused (with the reason the file cannot be used) or failed. A refused or failed video is replaced by uploading it again. Read a frame's picture with research_study_attachments_download by the frame's id.","deprecated":true,"tags":["research"],"x-cli-name":"research-study-attachments-get","x-point11-scope":"research:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The study attachment id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The study attachment id."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchStudyAttachmentsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/research/study-attachments/download":{"get":{"operationId":"research.study-attachments.download.v1","summary":"Download study attachments","description":"Download one ready study attachment by id, or one frame of a video's storyboard by the frame's id: its filename, media type and size, and a short-lived URL that GETs its bytes.","tags":["research"],"x-cli-name":"research-study-attachments-download","x-point11-scope":"research:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"query","required":true,"description":"The study attachment id, or a storyboard frame's id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The study attachment id, or a storyboard frame's id."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchStudyAttachmentsDownloadResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/campaigns/start-v3":{"post":{"operationId":"experience.campaigns.start.v3","summary":"Start campaigns (v3)","description":"Deprecated: use experience.campaigns.start.v4 (experience_campaigns_start_v4), which also takes stores picked on Google Maps (locationContexts) and then may answer before the campaign commits (delivery setting_up_stores); without them it starts exactly as v4, naming the same campaign for the same Idempotency-Key. Start an always-on Experience campaign over chosen customers (or, with follows, a share of a Discovery campaign's customers, as Bootup's Experience chooses them, which the campaign records and re-reads each run: a customer who left that campaign leaves, and a store its customers no longer cover lends its share, up to 100; while that campaign is archived its customers stay as they are until it is restored, and once it is deleted, for good; or, with locationKeys, every customer at chosen stores of the business profile, dealt one per store until 100, chosen once at the launch) and pages (or one connected app version on one mobile device), on chosen devices, shopped by chosen agents: Point11's own shopper unless agents names others, each of which runs its vendor's model in Point11's browser and shops every customer on every page and device as its own visit. It shops its whole grid now. Once that first run is accepted, a prorated share of its customers shops again across the rest of the UTC month, then every customer shops once each UTC month, placed on the business's published hours. A first run in which no visit delivered starts no monthly runs. Name competitorSourceCampaignId, a Discovery campaign on the same business profile, and every run also shops each customer's direct competitors: every brand that customer's latest settled conversation there labelled a direct competitor, read again each run, with no cap; a customer with none shops the pages alone. Subscribes nothing; each run uses the organization's existing allowance (and pay-as-you-go, if the organization turned it on). Returns the campaign and its launch entry; runs dispatch shortly after.","deprecated":true,"tags":["experience"],"x-cli-name":"experience-campaigns-start-v3","x-point11-scope":"experience:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceCampaignsStartV3Request"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceCampaignsStartV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/campaigns/start-v4":{"post":{"operationId":"experience.campaigns.start.v4","summary":"Start campaigns (v4)","description":"Start an always-on Experience campaign over chosen customers (or, with follows, a share of a Discovery campaign's customers, as Bootup's Experience chooses them, which the campaign records and re-reads each run: a customer who left that campaign leaves, and a store its customers no longer cover lends its share, up to 100; while that campaign is archived its customers stay until it is restored, and once it is deleted, for good; or every customer at chosen stores, dealt one per store until 100, chosen once at launch: the business profile's stores by locationKeys, stores picked on Google Maps by locationContexts, or both) and pages (or one connected app version on one mobile device), on chosen devices, shopped by Point11's shopper or the agents named, each its vendor's model in Point11's browser, as its own visit. It shops its whole grid now; once accepted, a prorated share shops again over the rest of the UTC month, then every customer monthly, on the business's published hours; a first run with no delivered visit starts none. With competitorSourceCampaignId (a Discovery campaign on its profile), each run also shops every brand the customer's latest settled conversation there labelled a direct competitor, re-read each run, uncapped. Subscribes nothing: runs use the allowance (and pay-as-you-go, if on). Returns the campaign and its launch entry; runs dispatch soon. A Google Maps pick the profile has no customers at yet is set up first, as a Discovery campaign sets up a store (verified, researched as a store and given the customers a Discovery campaign samples at each store, which experience_campaigns_prescreen_v2 counts and which are included in the plan at no charge): it then answers delivery setting_up_stores with the campaign id, and the campaign commits once the setup settles and shops its share of every store's customers, leaving out any store that could not be set up; the member who started it is emailed when a store was left out or the campaign could not start. A retry under the same Idempotency-Key answers what the setup became: still setting up, the campaign it committed, or, for a setup that ended without one, a conflict whose details.setupOutcome names how it ended; another body under that key is an idempotency conflict. iPhone Safari launches only with stores that already have customers. API keys name only stores that already have customers.","tags":["experience"],"x-cli-name":"experience-campaigns-start-v4","x-point11-scope":"experience:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceCampaignsStartV4Request"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceCampaignsStartV4Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/campaigns/prescreen-v2":{"post":{"operationId":"experience.campaigns.prescreen.v2","summary":"Prescreen campaigns (v2)","description":"Screen a complete Burst while the customer is still reviewing it, with the input experience_campaigns_start_v4 takes and mode burst. Commits, funds, and dispatches nothing. The same idempotency key reaches the same screening attempt, so a later start with that key and an unchanged grid answers from it instead of screening again. A launch that follows a Discovery campaign also learns how many of its customers it would shop (followedCustomerCount) and at how many of its stores (followedStoreCount); it refuses as the start would when that campaign cannot be followed. A launch that names stores likewise learns how many customers at them it would shop (locationCustomerCount) and at how many of them (locationStoreCount), and refuses as the start would when a store is not the profile's, none of their customers can visit, or its new stores would generate more customers than one Discovery settings Save may; when stores it picked on Google Maps have no customers yet, it also learns the one-time generation their setup needs, included in the plan at no charge (customerGeneration, its amountCents always 0).","tags":["experience"],"x-cli-name":"experience-campaigns-prescreen-v2","x-point11-scope":"experience:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceCampaignsPrescreenV2Request"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceCampaignsPrescreenV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/campaigns/update":{"post":{"operationId":"experience.campaigns.update.v1","summary":"Update campaigns","description":"Deprecated: use experience.campaign-settings.update.v1 (experience_campaign_settings_update), which renames a campaign with every other setting in one Save a person confirms; an API key cannot call that Save, so it keeps this rename. Rename one of the organization's active or paused Experience campaigns. Renaming to its current name changes nothing. Answers not found for any other id, including a campaign of another product.","deprecated":true,"tags":["experience"],"x-cli-name":"experience-campaigns-update","x-point11-scope":"experience:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceCampaignsUpdateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceCampaignsUpdateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/campaigns-v3/{id}":{"get":{"operationId":"experience.campaigns.get.v3","summary":"Get campaigns (v3)","description":"Get one Experience campaign's scope and progress: its websites, date window, results window (the day its figures are as of and the interactions and customers the 30 days ending with it hold), and how many journeys are scheduled, running, and finished. Set journeys to also read one page of its journeys in that window, as experience_journeys_list_v5 lists them. Read its figures with experience_campaign_analytics_get_v9.","tags":["experience"],"x-cli-name":"experience-campaigns-get-v3","x-point11-scope":"experience:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The Experience campaign's id","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The Experience campaign's id"}},{"name":"window","in":"query","required":false,"description":"Absent or null reads all time","content":{"application/json":{"schema":{"description":"Absent or null reads all time","anyOf":[{"type":"object","properties":{"from":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"to":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"widenWhenEmpty":{"default":false,"description":"When no day of the window has one of the campaign's interactions in its 30 days, read all time instead (dateScope.widenedToAllTime says so). Otherwise such a window reports dateScope.outOfRange.","type":"boolean"}},"required":["from","to"],"additionalProperties":false},{"type":"null"}]}}}},{"name":"segments","in":"query","required":false,"description":"Customer-level entries and the agent (ids from experience_campaign_segments_get), ANDed across axes; empty reads the whole cohort. Every customer attribute narrows by its own buckets, a store by its customers. An agent entry names one of point11, dots, spark, muse, grok_bot and narrows every figure to that agent's visits (scopeAgent states it); one at most, and with none every agent's visits are read together. The campaign's own planned and running counts stay campaign-wide and every agent's.","content":{"application/json":{"schema":{"default":[],"description":"Customer-level entries and the agent (ids from experience_campaign_segments_get), ANDed across axes; empty reads the whole cohort. Every customer attribute narrows by its own buckets, a store by its customers. An agent entry names one of point11, dots, spark, muse, grok_bot and narrows every figure to that agent's visits (scopeAgent states it); one at most, and with none every agent's visits are read together. The campaign's own planned and running counts stay campaign-wide and every agent's.","maxItems":100,"type":"array","items":{"type":"object","properties":{"axis":{"type":"string","enum":["agent","audience","channel","market","age","householdIncome","education","lifeStage","areaType","companySize","buyerRole","seniority","occupation","job","triggerType","intentStage","language","gender","store","customer"]},"id":{"type":"string","minLength":1,"maxLength":200}},"required":["axis","id"],"additionalProperties":false}}}}},{"name":"destination","in":"query","required":false,"description":"A campaign website's id (destinations[].id) or name; absent reads the campaign's own measured website","schema":{"description":"A campaign website's id (destinations[].id) or name; absent reads the campaign's own measured website","anyOf":[{"type":"string","minLength":1,"maxLength":2000},{"type":"null"}]}},{"name":"journeys","in":"query","required":false,"description":"Also read one page of the campaign's journeys (journeys), as experience_journeys_list_v5 lists them, in the same read: over the window this read resolves (dateScope.window) and its segments, filtered and sorted by the journeys* fields (ignored without it)","schema":{"default":false,"description":"Also read one page of the campaign's journeys (journeys), as experience_journeys_list_v5 lists them, in the same read: over the window this read resolves (dateScope.window) and its segments, filtered and sorted by the journeys* fields (ignored without it)","type":"boolean"}},{"name":"journeysWebsite","in":"query","required":false,"description":"Only journeys to this campaign website (a destinations[].id); absent, or an id none of the campaign's websites has, is every website","schema":{"description":"Only journeys to this campaign website (a destinations[].id); absent, or an id none of the campaign's websites has, is every website","type":"string","minLength":1,"maxLength":2000}},{"name":"journeysCursor","in":"query","required":false,"description":"Opaque cursor returned as journeys.nextCursor or journeys.previousCursor by another page","schema":{"description":"Opaque cursor returned as journeys.nextCursor or journeys.previousCursor by another page","type":"string","minLength":1,"maxLength":1024,"pattern":"^(after|before):([A-Za-z0-9_-]{1,1024})$"}},{"name":"journeysSearch","in":"query","required":false,"description":"The page's search over customer, website and coverage; it matches on the first 200 characters","schema":{"default":"","description":"The page's search over customer, website and coverage; it matches on the first 200 characters","type":"string","maxLength":2000}},{"name":"journeysOutcome","in":"query","required":false,"description":"achieved and not-achieved are a pass and a fail; unavailable is every settled visit with neither verdict (unscored, could not tell, or limited evidence), of which unscored and limited are the narrower parts","schema":{"default":"all","description":"achieved and not-achieved are a pass and a fail; unavailable is every settled visit with neither verdict (unscored, could not tell, or limited evidence), of which unscored and limited are the narrower parts","type":"string","enum":["all","achieved","not-achieved","unavailable","unscored","limited"]}},{"name":"journeysFriction","in":"query","required":false,"description":"Only journeys the evaluator found friction in","schema":{"default":false,"description":"Only journeys the evaluator found friction in","type":"boolean"}},{"name":"journeysDevice","in":"query","required":false,"description":"Only journeys on this device; absent is every device","schema":{"description":"Only journeys on this device; absent is every device","anyOf":[{"type":"string","enum":["desktop","mobile","ios_safari"]},{"type":"null"}]}},{"name":"journeysSort","in":"query","required":false,"description":"What the page sorts by: a device sorts by quality among its passed journeys","schema":{"default":"completedAt","description":"What the page sorts by: a device sorts by quality among its passed journeys","type":"string","enum":["customer","desktop","mobile","ios_safari","completedAt"]}},{"name":"journeysSortDesc","in":"query","required":false,"description":"Sort descending (the default)","schema":{"default":true,"description":"Sort descending (the default)","type":"boolean"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceCampaignsGetV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/campaign-settings/{id}":{"get":{"operationId":"experience.campaign-settings.get.v1","summary":"Get campaign settings","description":"Get an Experience campaign's saved setup, active, paused or archived alike: its targets (starting pages, signed-in access, apps), devices, objective, customers, the Discovery campaign a Pulse mirrors, a campaign follows for its customers or reads its customers' direct competitors from, and customerVersions, which always answers latest: every new cycle uses each customer's newest version. Its schedule, progress and standing are campaigns_summaries_get_v2's.","tags":["experience"],"x-cli-name":"experience-campaign-settings-get","x-point11-scope":"experience:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The Experience campaign's id","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The Experience campaign's id"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceCampaignSettingsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/campaign-settings-quotes/{id}":{"get":{"operationId":"experience.campaign-settings-quotes.get.v1","summary":"Get campaign settings quotes","description":"Review a Save of an Experience campaign's settings before making it, writing nothing: each change and when it starts (from the next cycle planned; a cycle already planned keeps what it planned), the change in estimated monthly visits at today's price, Billing's answer to the extra work and how the change reaches results. Pass the settingsRevision experience_campaign_settings_get returned as expectedSettingsRevision; refused when the settings changed since. `id` is the campaign's id.","tags":["experience"],"x-cli-name":"experience-campaign-settings-quotes-get","x-point11-scope":"experience:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The Experience campaign's id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The Experience campaign's id."}},{"name":"expectedSettingsRevision","in":"query","required":true,"description":"The settingsRevision the settings read (or a quote) returned.","schema":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The settingsRevision the settings read (or a quote) returned."}},{"name":"name","in":"query","required":false,"description":"The campaign's new name.","schema":{"type":"string","minLength":1,"maxLength":120,"description":"The campaign's new name."}},{"name":"browserDevices","in":"query","required":false,"description":"The devices each next cycle visits on: the whole set, at least one.","schema":{"description":"The devices each next cycle visits on: the whole set, at least one.","minItems":1,"maxItems":3,"type":"array","items":{"type":"string","enum":["desktop","mobile","ios_safari"]}}},{"name":"agents","in":"query","required":false,"description":"The agents that shop every next cycle, each on every customer, page and device: the whole set, at least one. point11 is Point11's own shopper; the others run the model their vendor's agent most likely uses, in Point11's browser. An added agent starts with the next cycle; a cycle already planned keeps its agents. A Mirror (Pulse) shops with point11 alone.","schema":{"description":"The agents that shop every next cycle, each on every customer, page and device: the whole set, at least one. point11 is Point11's own shopper; the others run the model their vendor's agent most likely uses, in Point11's browser. An added agent starts with the next cycle; a cycle already planned keeps its agents. A Mirror (Pulse) shops with point11 alone.","minItems":1,"maxItems":5,"type":"array","items":{"type":"string","enum":["point11","dots","spark","muse","grok_bot"]}}},{"name":"addCustomerIds","in":"query","required":false,"description":"Customers the next cycles also visit with.","schema":{"description":"Customers the next cycles also visit with.","maxItems":30000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},{"name":"removeCustomerIds","in":"query","required":false,"description":"Customers taken off the list: they stop at once, even in a cycle already planned, and their past visits stay.","schema":{"description":"Customers taken off the list: they stop at once, even in a cycle already planned, and their past visits stay.","maxItems":30000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},{"name":"customerVersionPolicy","in":"query","required":false,"description":"Every new cycle uses each customer's newest version, so `latest` changes nothing. `pinned` is no longer a choice: 409 PRECONDITION_FAILED, details.reason invalid_change, details.field customerVersionPolicy.","schema":{"description":"Every new cycle uses each customer's newest version, so `latest` changes nothing. `pinned` is no longer a choice: 409 PRECONDITION_FAILED, details.reason invalid_change, details.field customerVersionPolicy.","type":"string","enum":["pinned","latest"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceCampaignSettingsQuotesGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/campaign-settings/update":{"post":{"operationId":"experience.campaign-settings.update.v1","summary":"Update campaign settings","description":"Save an Experience campaign's settings in place, all or nothing: its name, devices and customers, from the next cycle planned; results continue on the same campaign and take in the change over its next 30 days. Every new cycle uses each customer's newest version, so customerVersionPolicy latest changes nothing and pinned is refused. Its websites, pages, platform, access and mode never change, and an always-on campaign has no schedule to change: each listed customer shops once every UTC month. Nothing is charged at Save: delivered visits accrue against the plan. Pass expectedSettingsRevision from experience_campaign_settings_get; a Save whose settings moved since is refused (STALE_WRITE). Pass reviewedEstimate from experience_campaign_settings_quotes_get to also refuse one whose estimate moved, or null to save at the current estimate. A person confirms it.","tags":["experience"],"x-cli-name":"experience-campaign-settings-update","x-point11-scope":"experience:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}},{"name":"Point11-Confirm","in":"header","required":true,"description":"Explicit human confirmation of this operation's effect.","schema":{"type":"string","enum":["true"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceCampaignSettingsUpdateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceCampaignSettingsUpdateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/campaign-analytics-v9/{id}":{"get":{"operationId":"experience.campaign-analytics.get.v9","summary":"Get campaign analytics (v9)","description":"Get an Experience campaign's measured figures for one breakdown (such as overview, devices or frictions) over a date range and optional customer segments. Each figure is over the campaign's interactions (each visit with a verdict: every website, device, repetition and cycle) in the 30 UTC days ending its day: a single figure as of results.asOf (the range's end, or its last interaction day before), a line one point per day (null where its 30 days hold none), a change the figure minus its value 30 days earlier. A rate is a share of the window's interactions, null with none; figures carry no interval and state the distinct customers behind them (passCustomers, ratedCustomers, earlierPassCustomers). The Experience Score (0 to 100; no single journey has one) is pass rate × (50 + 10 × average stars on passes), null without stars. On overview and revenue, revenueValue is the own website's Experience dollars against competitors over the window's pairs, with each product's assumptions and point value (overview adds revenueValueTrend, revenueValueChange); a point of a product's gap is worth its AI-influenced market (SAM × AI influence, Tools › Products) ÷ 100. drivers count per website passed journeys with a strength (wins) and failed ones with an issue (losses), named by the Advisor from the scorer's notes (a failure blamed on the shopper is none); the overview also counts the own website against each competitor over matched pairs (against). Set panels to also read the overview panels.","tags":["experience"],"x-cli-name":"experience-campaign-analytics-get-v9","x-point11-scope":"experience:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The Experience campaign's id","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The Experience campaign's id"}},{"name":"window","in":"query","required":false,"description":"Absent or null reads all time","content":{"application/json":{"schema":{"description":"Absent or null reads all time","anyOf":[{"type":"object","properties":{"from":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"to":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"widenWhenEmpty":{"default":false,"description":"When no day of the window has one of the campaign's interactions in its 30 days, read all time instead (dateScope.widenedToAllTime says so). Otherwise such a window reports dateScope.outOfRange.","type":"boolean"}},"required":["from","to"],"additionalProperties":false},{"type":"null"}]}}}},{"name":"segments","in":"query","required":false,"description":"Customer-level entries and the agent (ids from experience_campaign_segments_get), ANDed across axes; empty reads the whole cohort. Every customer attribute narrows by its own buckets, a store by its customers. An agent entry names one of point11, dots, spark, muse, grok_bot and narrows every figure to that agent's visits (scopeAgent states it); one at most, and with none every agent's visits are read together. The campaign's own planned and running counts stay campaign-wide and every agent's.","content":{"application/json":{"schema":{"default":[],"description":"Customer-level entries and the agent (ids from experience_campaign_segments_get), ANDed across axes; empty reads the whole cohort. Every customer attribute narrows by its own buckets, a store by its customers. An agent entry names one of point11, dots, spark, muse, grok_bot and narrows every figure to that agent's visits (scopeAgent states it); one at most, and with none every agent's visits are read together. The campaign's own planned and running counts stay campaign-wide and every agent's.","maxItems":100,"type":"array","items":{"type":"object","properties":{"axis":{"type":"string","enum":["agent","audience","channel","market","age","householdIncome","education","lifeStage","areaType","companySize","buyerRole","seniority","occupation","job","triggerType","intentStage","language","gender","store","customer"]},"id":{"type":"string","minLength":1,"maxLength":200}},"required":["axis","id"],"additionalProperties":false}}}}},{"name":"destination","in":"query","required":false,"description":"A campaign website's id (destinations[].id) or name; absent reads the campaign's own measured website","schema":{"description":"A campaign website's id (destinations[].id) or name; absent reads the campaign's own measured website","anyOf":[{"type":"string","minLength":1,"maxLength":2000},{"type":"null"}]}},{"name":"tab","in":"query","required":true,"description":"Which breakdown to read: overview, a segment dimension, or competitors","schema":{"type":"string","enum":["overview","revenue","audiences","channels","topics","locations","competitors","engines","sentiment","forecast"],"description":"Which breakdown to read: overview, a segment dimension, or competitors"}},{"name":"panels","in":"query","required":false,"description":"Also read the overview panels (customerLocations and replayJourneys, as experience_campaign_overview_get_v7 answers them) in the same read, under the same scope; panels is null when false","schema":{"default":false,"description":"Also read the overview panels (customerLocations and replayJourneys, as experience_campaign_overview_get_v7 answers them) in the same read, under the same scope; panels is null when false","type":"boolean"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceCampaignAnalyticsGetV9Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/brand-maps-v4/{id}":{"get":{"operationId":"experience.brand-maps.get.v4","summary":"Get brand maps (v4)","description":"Get an Experience campaign's Brands map over the results window experience_campaign_analytics_get_v9 reads, under optional customer segments: the own website against each competitor its customers also shopped, over matched pairs (one customer's visits to both in a cycle, on one device). Each competitor carries both sides' Experience Score, pass rate and stars over those pairs, the gap in points, its Experience dollars, and the pairs the website won and lost (a pass beats a failure; of two passes more stars win; the rest decide nothing). Beside them: the own website's score over all its journeys, and its dollars by product with each product's assumptions and point value, valued as experience_campaign_analytics_get_v9 values them. No figure carries an interval or noise flag. Answers the campaign's scope and progress as experience_campaigns_get_v3 does.","tags":["experience"],"x-cli-name":"experience-brand-maps-get-v4","x-point11-scope":"experience:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The Experience campaign's id","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The Experience campaign's id"}},{"name":"window","in":"query","required":false,"description":"Absent or null reads all time","content":{"application/json":{"schema":{"description":"Absent or null reads all time","anyOf":[{"type":"object","properties":{"from":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"to":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"widenWhenEmpty":{"default":false,"description":"When no day of the window has one of the campaign's interactions in its 30 days, read all time instead (dateScope.widenedToAllTime says so). Otherwise such a window reports dateScope.outOfRange.","type":"boolean"}},"required":["from","to"],"additionalProperties":false},{"type":"null"}]}}}},{"name":"segments","in":"query","required":false,"description":"Customer-level entries and the agent (ids from experience_campaign_segments_get), ANDed across axes; empty reads the whole cohort. Every customer attribute narrows by its own buckets, a store by its customers. An agent entry names one of point11, dots, spark, muse, grok_bot and narrows every figure to that agent's visits (scopeAgent states it); one at most, and with none every agent's visits are read together. The campaign's own planned and running counts stay campaign-wide and every agent's.","content":{"application/json":{"schema":{"default":[],"description":"Customer-level entries and the agent (ids from experience_campaign_segments_get), ANDed across axes; empty reads the whole cohort. Every customer attribute narrows by its own buckets, a store by its customers. An agent entry names one of point11, dots, spark, muse, grok_bot and narrows every figure to that agent's visits (scopeAgent states it); one at most, and with none every agent's visits are read together. The campaign's own planned and running counts stay campaign-wide and every agent's.","maxItems":100,"type":"array","items":{"type":"object","properties":{"axis":{"type":"string","enum":["agent","audience","channel","market","age","householdIncome","education","lifeStage","areaType","companySize","buyerRole","seniority","occupation","job","triggerType","intentStage","language","gender","store","customer"]},"id":{"type":"string","minLength":1,"maxLength":200}},"required":["axis","id"],"additionalProperties":false}}}}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceBrandMapsGetV4Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/brand-matchups-v3/{id}":{"get":{"operationId":"experience.brand-matchups.get.v3","summary":"Get brand matchups (v3)","description":"Deprecated: no successor. The Brands map no longer reads a matchup: a competitor opens its record and why we won and lost (experience.competitor-reasons.get.v2). This version still answers one competitor's matchup from an Experience campaign's Brands map, under the same window and segments: the matched pairs cut by product (revenue line), each with its record of pairs won and lost, and the journeys that failed on the campaign's website while the same customer's goal passed on the competitor's, each with its two replays, over the pairs dated in the 30 UTC days ending with the map's results.asOf, its Experience dollars at each product's point (its AI-influenced market ÷ 100).","deprecated":true,"tags":["experience"],"x-cli-name":"experience-brand-matchups-get-v3","x-point11-scope":"experience:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The Experience campaign's id","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The Experience campaign's id"}},{"name":"from","in":"query","required":false,"description":"The window's start; with to, or neither for all time","schema":{"description":"The window's start; with to, or neither for all time","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},{"name":"to","in":"query","required":false,"description":"The window's end; with from, or neither for all time","schema":{"description":"The window's end; with from, or neither for all time","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},{"name":"widenWhenEmpty","in":"query","required":false,"description":"When no day of the window has one of the campaign's interactions in its 30 days, read all time instead (dateScope.widenedToAllTime says so). Otherwise such a window reports dateScope.outOfRange.","schema":{"default":false,"description":"When no day of the window has one of the campaign's interactions in its 30 days, read all time instead (dateScope.widenedToAllTime says so). Otherwise such a window reports dateScope.outOfRange.","type":"boolean"}},{"name":"segments","in":"query","required":false,"description":"Customer-level entries as axis:id (ids from experience_campaign_segments_get), ANDed across axes; empty reads the whole cohort. Every customer attribute narrows by its own buckets, a store by its customers. An agent entry names one of point11, dots, spark, muse, grok_bot and narrows every figure to that agent's visits (scopeAgent states it); one at most, and with none every agent's visits are read together.","schema":{"default":[],"description":"Customer-level entries as axis:id (ids from experience_campaign_segments_get), ANDed across axes; empty reads the whole cohort. Every customer attribute narrows by its own buckets, a store by its customers. An agent entry names one of point11, dots, spark, muse, grok_bot and narrows every figure to that agent's visits (scopeAgent states it); one at most, and with none every agent's visits are read together.","maxItems":100,"type":"array","items":{"type":"string","pattern":"^(audience|channel|market|age|householdIncome|education|lifeStage|areaType|companySize|buyerRole|seniority|occupation|job|triggerType|intentStage|language|gender|store|customer):(.{1,200})$"}}},{"name":"agent","in":"query","required":false,"description":"The segment scope's agent entry (the object form's {axis: agent}): every figure is of that agent's visits alone; absent reads every agent's","schema":{"description":"The segment scope's agent entry (the object form's {axis: agent}): every figure is of that agent's visits alone; absent reads every agent's","type":"string","enum":["point11","dots","spark","muse","grok_bot"]}},{"name":"competitor","in":"query","required":true,"description":"A competitor's website id, from experience_brand_maps_get_v4's competitors[].id","schema":{"type":"string","minLength":1,"maxLength":2000,"description":"A competitor's website id, from experience_brand_maps_get_v4's competitors[].id"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceBrandMatchupsGetV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/competitor-reasons-v2/{id}":{"get":{"operationId":"experience.competitor-reasons.get.v2","summary":"Get competitor reasons (v2)","description":"Get why an Experience campaign's own website won and lost its matched pairs with one competitor from its Brands map, under the same window and segments: exactly the drivers experience_campaign_analytics_get_v9 counts against that competitor on the overview. Over the pairs whose visit of the website is dated in the 30 UTC days ending with the map's results.asOf and that went to a side (a pass beats a failure, and of two passes more stars win; a failure blamed on the shopper decides nothing), a win counts each strength the website's journey carried and a loss each issue, as the issue grouping recorded them from what the scorer wrote, or Not grouped yet for what no grouping run has grouped, counted in pairs. A pair carrying several reasons counts under each.","tags":["experience"],"x-cli-name":"experience-competitor-reasons-get-v2","x-point11-scope":"experience:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The Experience campaign's id","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The Experience campaign's id"}},{"name":"from","in":"query","required":false,"description":"The window's start; with to, or neither for all time","schema":{"description":"The window's start; with to, or neither for all time","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},{"name":"to","in":"query","required":false,"description":"The window's end; with from, or neither for all time","schema":{"description":"The window's end; with from, or neither for all time","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},{"name":"widenWhenEmpty","in":"query","required":false,"description":"When no day of the window has one of the campaign's interactions in its 30 days, read all time instead (dateScope.widenedToAllTime says so). Otherwise such a window reports dateScope.outOfRange.","schema":{"default":false,"description":"When no day of the window has one of the campaign's interactions in its 30 days, read all time instead (dateScope.widenedToAllTime says so). Otherwise such a window reports dateScope.outOfRange.","type":"boolean"}},{"name":"segments","in":"query","required":false,"description":"Customer-level entries as axis:id (ids from experience_campaign_segments_get), ANDed across axes; empty reads the whole cohort. Every customer attribute narrows by its own buckets, a store by its customers. An agent entry names one of point11, dots, spark, muse, grok_bot and narrows every figure to that agent's visits (scopeAgent states it); one at most, and with none every agent's visits are read together.","schema":{"default":[],"description":"Customer-level entries as axis:id (ids from experience_campaign_segments_get), ANDed across axes; empty reads the whole cohort. Every customer attribute narrows by its own buckets, a store by its customers. An agent entry names one of point11, dots, spark, muse, grok_bot and narrows every figure to that agent's visits (scopeAgent states it); one at most, and with none every agent's visits are read together.","maxItems":100,"type":"array","items":{"type":"string","pattern":"^(audience|channel|market|age|householdIncome|education|lifeStage|areaType|companySize|buyerRole|seniority|occupation|job|triggerType|intentStage|language|gender|store|customer):(.{1,200})$"}}},{"name":"agent","in":"query","required":false,"description":"The segment scope's agent entry (the object form's {axis: agent}): every figure is of that agent's visits alone; absent reads every agent's","schema":{"description":"The segment scope's agent entry (the object form's {axis: agent}): every figure is of that agent's visits alone; absent reads every agent's","type":"string","enum":["point11","dots","spark","muse","grok_bot"]}},{"name":"competitor","in":"query","required":true,"description":"A competitor's website id, from experience_brand_maps_get_v4's competitors[].id","schema":{"type":"string","minLength":1,"maxLength":2000,"description":"A competitor's website id, from experience_brand_maps_get_v4's competitors[].id"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceCompetitorReasonsGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/matrix-maps-v4/{id}":{"get":{"operationId":"experience.matrix-maps.get.v4","summary":"Get matrix maps (v4)","description":"Get an Experience campaign's Matrix map over the results window experience_campaign_analytics_get_v9 reads, under optional customer segments. websites: each website shopped, its own and each competitor's (named for its Discovery brand), with Experience Score, site pass rate, judged journeys, its interactions in the window and, apart, visits the scorer could not tell (blocked or otherwise), which no score counts. groupings: each product (revenue line), audience and channel of the own website with its score there and against the competitors the same customers shopped (each side's mean weighted by matched pairs: one customer's journeys on both sites in a cycle, on one device), the gap in points, a product's Experience dollars as experience_campaign_analytics_get_v9 values them, and what its sizes are in. Segment ids are the profile's revenue, audience and channel mix ids, keyed alike by Discovery's reports for the competitorSourceCampaignId campaign, whose win rates say how often AI picks each. No figure carries an interval or noise flag. Answers the campaign's scope and progress as experience_campaigns_get_v3 does, without favicons.","tags":["experience"],"x-cli-name":"experience-matrix-maps-get-v4","x-point11-scope":"experience:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The Experience campaign's id","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The Experience campaign's id"}},{"name":"window","in":"query","required":false,"description":"Absent or null reads all time","content":{"application/json":{"schema":{"description":"Absent or null reads all time","anyOf":[{"type":"object","properties":{"from":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"to":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"widenWhenEmpty":{"default":false,"description":"When no day of the window has one of the campaign's interactions in its 30 days, read all time instead (dateScope.widenedToAllTime says so). Otherwise such a window reports dateScope.outOfRange.","type":"boolean"}},"required":["from","to"],"additionalProperties":false},{"type":"null"}]}}}},{"name":"segments","in":"query","required":false,"description":"Customer-level entries and the agent (ids from experience_campaign_segments_get), ANDed across axes; empty reads the whole cohort. Every customer attribute narrows by its own buckets, a store by its customers. An agent entry names one of point11, dots, spark, muse, grok_bot and narrows every figure to that agent's visits (scopeAgent states it); one at most, and with none every agent's visits are read together. The campaign's own planned and running counts stay campaign-wide and every agent's.","content":{"application/json":{"schema":{"default":[],"description":"Customer-level entries and the agent (ids from experience_campaign_segments_get), ANDed across axes; empty reads the whole cohort. Every customer attribute narrows by its own buckets, a store by its customers. An agent entry names one of point11, dots, spark, muse, grok_bot and narrows every figure to that agent's visits (scopeAgent states it); one at most, and with none every agent's visits are read together. The campaign's own planned and running counts stay campaign-wide and every agent's.","maxItems":100,"type":"array","items":{"type":"object","properties":{"axis":{"type":"string","enum":["agent","audience","channel","market","age","householdIncome","education","lifeStage","areaType","companySize","buyerRole","seniority","occupation","job","triggerType","intentStage","language","gender","store","customer"]},"id":{"type":"string","minLength":1,"maxLength":200}},"required":["axis","id"],"additionalProperties":false}}}}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceMatrixMapsGetV4Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/friction-maps-v3/{id}":{"get":{"operationId":"experience.friction-maps.get.v3","summary":"Get friction maps (v3)","description":"Get an Experience campaign's Journeys map of one website over the results window experience_campaign_analytics_get_v9 reads, under optional customer segments: its judged journeys and their customers, entry pages, the pages walked in the order journeys reach them, the journeys between each pair, and the failed journeys ending on each, each count split into passed clean, passed with friction the scorer recorded, or failed. A page is a URL's host and path, id-like segments read as :id; the twelve most reached are listed, the rest as one, journeys naming no page as one; each has up to four screens (its latest journeys' first screenshots). With device, only that device's journeys (devices names the campaign's). Its journeys are those the website's pass rate divides by, so its failures are that rate's. Answers the campaign's scope and progress as experience_campaigns_get_v3 does.","tags":["experience"],"x-cli-name":"experience-friction-maps-get-v3","x-point11-scope":"experience:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The Experience campaign's id","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The Experience campaign's id"}},{"name":"window","in":"query","required":false,"description":"Absent or null reads all time","content":{"application/json":{"schema":{"description":"Absent or null reads all time","anyOf":[{"type":"object","properties":{"from":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"to":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"widenWhenEmpty":{"default":false,"description":"When no day of the window has one of the campaign's interactions in its 30 days, read all time instead (dateScope.widenedToAllTime says so). Otherwise such a window reports dateScope.outOfRange.","type":"boolean"}},"required":["from","to"],"additionalProperties":false},{"type":"null"}]}}}},{"name":"segments","in":"query","required":false,"description":"Customer-level entries and the agent (ids from experience_campaign_segments_get), ANDed across axes; empty reads the whole cohort. Every customer attribute narrows by its own buckets, a store by its customers. An agent entry names one of point11, dots, spark, muse, grok_bot and narrows every figure to that agent's visits (scopeAgent states it); one at most, and with none every agent's visits are read together. The campaign's own planned and running counts stay campaign-wide and every agent's.","content":{"application/json":{"schema":{"default":[],"description":"Customer-level entries and the agent (ids from experience_campaign_segments_get), ANDed across axes; empty reads the whole cohort. Every customer attribute narrows by its own buckets, a store by its customers. An agent entry names one of point11, dots, spark, muse, grok_bot and narrows every figure to that agent's visits (scopeAgent states it); one at most, and with none every agent's visits are read together. The campaign's own planned and running counts stay campaign-wide and every agent's.","maxItems":100,"type":"array","items":{"type":"object","properties":{"axis":{"type":"string","enum":["agent","audience","channel","market","age","householdIncome","education","lifeStage","areaType","companySize","buyerRole","seniority","occupation","job","triggerType","intentStage","language","gender","store","customer"]},"id":{"type":"string","minLength":1,"maxLength":200}},"required":["axis","id"],"additionalProperties":false}}}}},{"name":"destination","in":"query","required":false,"description":"A campaign website's id (destinations[].id) or name; absent reads the campaign's own measured website","schema":{"description":"A campaign website's id (destinations[].id) or name; absent reads the campaign's own measured website","anyOf":[{"type":"string","minLength":1,"maxLength":2000},{"type":"null"}]}},{"name":"device","in":"query","required":false,"description":"Read only the journeys visited on this device (one of devices); absent reads every device","schema":{"description":"Read only the journeys visited on this device (one of devices); absent reads every device","type":"string","enum":["desktop","mobile","ios_safari"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceFrictionMapsGetV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/friction-map-pages-v3/{id}":{"get":{"operationId":"experience.friction-map-pages.get.v3","summary":"Get friction map pages (v3)","description":"Get the frictions on one page of an Experience campaign's Journeys map, under the scope experience_friction_maps_get_v3 was read with, over its journeys: those dated in the 30 UTC days ending with its results.asOf. Each friction the scoring engine placed on a step a journey spent on the page, in its own words, with its severity, the campaign's named issue where the issue grouping that runs when a cycle publishes has grouped it, and the journey's replay.","tags":["experience"],"x-cli-name":"experience-friction-map-pages-get-v3","x-point11-scope":"experience:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The Experience campaign's id","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The Experience campaign's id"}},{"name":"from","in":"query","required":false,"description":"The window's start; with to, or neither for all time","schema":{"description":"The window's start; with to, or neither for all time","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},{"name":"to","in":"query","required":false,"description":"The window's end; with from, or neither for all time","schema":{"description":"The window's end; with from, or neither for all time","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},{"name":"widenWhenEmpty","in":"query","required":false,"description":"When no day of the window has one of the campaign's interactions in its 30 days, read all time instead (dateScope.widenedToAllTime says so). Otherwise such a window reports dateScope.outOfRange.","schema":{"default":false,"description":"When no day of the window has one of the campaign's interactions in its 30 days, read all time instead (dateScope.widenedToAllTime says so). Otherwise such a window reports dateScope.outOfRange.","type":"boolean"}},{"name":"segments","in":"query","required":false,"description":"Customer-level entries as axis:id (ids from experience_campaign_segments_get), ANDed across axes; empty reads the whole cohort. Every customer attribute narrows by its own buckets, a store by its customers. An agent entry names one of point11, dots, spark, muse, grok_bot and narrows every figure to that agent's visits (scopeAgent states it); one at most, and with none every agent's visits are read together.","schema":{"default":[],"description":"Customer-level entries as axis:id (ids from experience_campaign_segments_get), ANDed across axes; empty reads the whole cohort. Every customer attribute narrows by its own buckets, a store by its customers. An agent entry names one of point11, dots, spark, muse, grok_bot and narrows every figure to that agent's visits (scopeAgent states it); one at most, and with none every agent's visits are read together.","maxItems":100,"type":"array","items":{"type":"string","pattern":"^(audience|channel|market|age|householdIncome|education|lifeStage|areaType|companySize|buyerRole|seniority|occupation|job|triggerType|intentStage|language|gender|store|customer):(.{1,200})$"}}},{"name":"agent","in":"query","required":false,"description":"The segment scope's agent entry (the object form's {axis: agent}): every figure is of that agent's visits alone; absent reads every agent's","schema":{"description":"The segment scope's agent entry (the object form's {axis: agent}): every figure is of that agent's visits alone; absent reads every agent's","type":"string","enum":["point11","dots","spark","muse","grok_bot"]}},{"name":"destination","in":"query","required":false,"description":"A campaign website's id (destinations[].id) or name; absent reads the campaign's own measured website","schema":{"description":"A campaign website's id (destinations[].id) or name; absent reads the campaign's own measured website","anyOf":[{"type":"string","minLength":1,"maxLength":2000},{"type":"null"}]}},{"name":"device","in":"query","required":false,"description":"Read only the journeys visited on this device (one of devices); absent reads every device","schema":{"description":"Read only the journeys visited on this device (one of devices); absent reads every device","type":"string","enum":["desktop","mobile","ios_safari"]}},{"name":"page","in":"query","required":true,"description":"A page's host and path with every segment that identifies one thing or one person read as :id (shop.example/products/:id), \":other\" for every page past the 12 most reached as one, or \":unknown\" for the journeys whose evidence names no page and the frictions seen where no page was recorded","schema":{"type":"string","minLength":1,"maxLength":2048,"description":"A page's host and path with every segment that identifies one thing or one person read as :id (shop.example/products/:id), \":other\" for every page past the 12 most reached as one, or \":unknown\" for the journeys whose evidence names no page and the frictions seen where no page was recorded"}},{"name":"offset","in":"query","required":false,"description":"How many of the page's frictions come before the ones to list: the count already listed, to read on","schema":{"default":0,"description":"How many of the page's frictions come before the ones to list: the count already listed, to read on","type":"integer","minimum":0,"maximum":1000000}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceFrictionMapPagesGetV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/campaign-overview-v7/{id}":{"get":{"operationId":"experience.campaign-overview.get.v7","summary":"Get campaign overview (v7)","description":"Get an Experience campaign's overview panels over a results window: the campaign's interactions (each campaign visit with a verdict, every repetition, device and cycle) dated in the 30 UTC days ending with results.asOf (the range's end, or the last interaction day before it), under optional customer segments: where the customers behind those interactions are, with each one's journeys and passes, and the newest of its journeys per customer and device queued for review, each previewed by its stored thumbnail. results names that window as experience_campaign_analytics_get_v9 names it; it is null, and both panels empty, while the scope holds no interaction. Read a journey's captured stages with experience_journeys_get_v3.","tags":["experience"],"x-cli-name":"experience-campaign-overview-get-v7","x-point11-scope":"experience:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The Experience campaign's id","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The Experience campaign's id"}},{"name":"window","in":"query","required":false,"description":"Absent or null reads all time","content":{"application/json":{"schema":{"description":"Absent or null reads all time","anyOf":[{"type":"object","properties":{"from":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"to":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"widenWhenEmpty":{"default":false,"description":"When no day of the window has one of the campaign's interactions in its 30 days, read all time instead (dateScope.widenedToAllTime says so). Otherwise such a window reports dateScope.outOfRange.","type":"boolean"}},"required":["from","to"],"additionalProperties":false},{"type":"null"}]}}}},{"name":"segments","in":"query","required":false,"description":"Customer-level entries and the agent (ids from experience_campaign_segments_get), ANDed across axes; empty reads the whole cohort. Every customer attribute narrows by its own buckets, a store by its customers. An agent entry names one of point11, dots, spark, muse, grok_bot and narrows every figure to that agent's visits (scopeAgent states it); one at most, and with none every agent's visits are read together. The campaign's own planned and running counts stay campaign-wide and every agent's.","content":{"application/json":{"schema":{"default":[],"description":"Customer-level entries and the agent (ids from experience_campaign_segments_get), ANDed across axes; empty reads the whole cohort. Every customer attribute narrows by its own buckets, a store by its customers. An agent entry names one of point11, dots, spark, muse, grok_bot and narrows every figure to that agent's visits (scopeAgent states it); one at most, and with none every agent's visits are read together. The campaign's own planned and running counts stay campaign-wide and every agent's.","maxItems":100,"type":"array","items":{"type":"object","properties":{"axis":{"type":"string","enum":["agent","audience","channel","market","age","householdIncome","education","lifeStage","areaType","companySize","buyerRole","seniority","occupation","job","triggerType","intentStage","language","gender","store","customer"]},"id":{"type":"string","minLength":1,"maxLength":200}},"required":["axis","id"],"additionalProperties":false}}}}},{"name":"destination","in":"query","required":false,"description":"A campaign website's id (destinations[].id) or name; absent reads the campaign's own measured website","schema":{"description":"A campaign website's id (destinations[].id) or name; absent reads the campaign's own measured website","anyOf":[{"type":"string","minLength":1,"maxLength":2000},{"type":"null"}]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceCampaignOverviewGetV7Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/campaign-segments/{id}":{"get":{"operationId":"experience.campaign-segments.get.v1","summary":"Get campaign segments","description":"Get the customers, stores, audiences, channels, and every other customer attribute's buckets an Experience campaign covers, to narrow its reads by segment. A campaign your organization does not own has none.","tags":["experience"],"x-cli-name":"experience-campaign-segments-get","x-point11-scope":"experience:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceCampaignSegmentsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/campaign-customers-v2":{"get":{"operationId":"experience.campaign-customers.list.v2","summary":"List campaign customers (v2)","description":"Deprecated: use experience.campaign-customers.list.v3 (experience_campaign_customers_list_v3), which names no faviconLightUrl or faviconDarkUrl: a favicon is one image for both themes, faviconUrl. This version answers the same and names both, never sent. List an Experience campaign's customers a page at a time, newest first: every customer its journeys were planned for who is still active in its business profile, with their traits, audiences, and sources. query narrows by name or job title and groupIds to members of those audiences; selectedGroupIds also answers which of the matching customers belong to those audiences, across every page. A campaign your organization does not own is not found. Page with nextCursor at the same limit.","deprecated":true,"tags":["experience"],"x-cli-name":"experience-campaign-customers-list-v2","x-point11-scope":"experience:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"campaignId","in":"query","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"query","in":"query","required":false,"schema":{"type":"string","maxLength":200}},{"name":"groupIds","in":"query","required":false,"schema":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},{"name":"selectedGroupIds","in":"query","required":false,"schema":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},{"name":"filters","in":"query","required":false,"description":"Field conditions, each `<field>:<operator>:<value>`. Text fields (location, employer, trigger) take contains, does_not_contain, is or starts_with and the words. Number fields (age, householdIncome, companySize, annualRevenue) take gt, gte, lt, lte or eq and a number, or between and `min..max`. Classification fields, each band under its fact's key as <key>.band (gender, age.band, language, market, areaType, education, lifeStage, householdIncome.band, occupation, seniority, companySize.band, buyerType, audience, product, channel, buyerRole, intentStage, job, triggerType), take is_any_of or is_none_of and comma-separated ids from business_customer_filter_options_get_v2 (buyerType takes consumer or organization), `none` for a customer with no value. createdAt takes on_or_after or on_or_before and an ISO date, or between and `from..to`, read in UTC.","schema":{"description":"Field conditions, each `<field>:<operator>:<value>`. Text fields (location, employer, trigger) take contains, does_not_contain, is or starts_with and the words. Number fields (age, householdIncome, companySize, annualRevenue) take gt, gte, lt, lte or eq and a number, or between and `min..max`. Classification fields, each band under its fact's key as <key>.band (gender, age.band, language, market, areaType, education, lifeStage, householdIncome.band, occupation, seniority, companySize.band, buyerType, audience, product, channel, buyerRole, intentStage, job, triggerType), take is_any_of or is_none_of and comma-separated ids from business_customer_filter_options_get_v2 (buyerType takes consumer or organization), `none` for a customer with no value. createdAt takes on_or_after or on_or_before and an ISO date, or between and `from..to`, read in UTC.","maxItems":20,"type":"array","items":{"type":"string","minLength":5,"maxLength":4000,"pattern":"^[A-Za-z]+(?:\\.band)?:[a-z_]+:.+$"}}},{"name":"filterMatch","in":"query","required":false,"description":"Whether a customer matches every condition (all, the default) or any one","schema":{"description":"Whether a customer matches every condition (all, the default) or any one","type":"string","enum":["all","any"]}},{"name":"lifecycleStatus","in":"query","required":false,"description":"active (default): the campaign's customers on its roster now; archived: the customers it has held who are archived since; all: both.","schema":{"description":"active (default): the campaign's customers on its roster now; archived: the customers it has held who are archived since; all: both.","type":"string","enum":["active","archived","all"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceCampaignCustomersListV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/campaign-customers-v3":{"get":{"operationId":"experience.campaign-customers.list.v3","summary":"List campaign customers (v3)","description":"List an Experience campaign's customers a page at a time, newest first: every customer its journeys were planned for who is still active in its business profile, with their traits, audiences, and sources. query narrows by name or job title and groupIds to members of those audiences; selectedGroupIds also answers which of the matching customers belong to those audiences, across every page. A campaign your organization does not own is not found. Page with nextCursor at the same limit.","tags":["experience"],"x-cli-name":"experience-campaign-customers-list-v3","x-point11-scope":"experience:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"campaignId","in":"query","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"query","in":"query","required":false,"schema":{"type":"string","maxLength":200}},{"name":"groupIds","in":"query","required":false,"schema":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},{"name":"selectedGroupIds","in":"query","required":false,"schema":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},{"name":"filters","in":"query","required":false,"description":"Field conditions, each `<field>:<operator>:<value>`. Text fields (location, employer, trigger) take contains, does_not_contain, is or starts_with and the words. Number fields (age, householdIncome, companySize, annualRevenue) take gt, gte, lt, lte or eq and a number, or between and `min..max`. Classification fields, each band under its fact's key as <key>.band (gender, age.band, language, market, areaType, education, lifeStage, householdIncome.band, occupation, seniority, companySize.band, buyerType, audience, product, channel, buyerRole, intentStage, job, triggerType), take is_any_of or is_none_of and comma-separated ids from business_customer_filter_options_get_v2 (buyerType takes consumer or organization), `none` for a customer with no value. createdAt takes on_or_after or on_or_before and an ISO date, or between and `from..to`, read in UTC.","schema":{"description":"Field conditions, each `<field>:<operator>:<value>`. Text fields (location, employer, trigger) take contains, does_not_contain, is or starts_with and the words. Number fields (age, householdIncome, companySize, annualRevenue) take gt, gte, lt, lte or eq and a number, or between and `min..max`. Classification fields, each band under its fact's key as <key>.band (gender, age.band, language, market, areaType, education, lifeStage, householdIncome.band, occupation, seniority, companySize.band, buyerType, audience, product, channel, buyerRole, intentStage, job, triggerType), take is_any_of or is_none_of and comma-separated ids from business_customer_filter_options_get_v2 (buyerType takes consumer or organization), `none` for a customer with no value. createdAt takes on_or_after or on_or_before and an ISO date, or between and `from..to`, read in UTC.","maxItems":20,"type":"array","items":{"type":"string","minLength":5,"maxLength":4000,"pattern":"^[A-Za-z]+(?:\\.band)?:[a-z_]+:.+$"}}},{"name":"filterMatch","in":"query","required":false,"description":"Whether a customer matches every condition (all, the default) or any one","schema":{"description":"Whether a customer matches every condition (all, the default) or any one","type":"string","enum":["all","any"]}},{"name":"lifecycleStatus","in":"query","required":false,"description":"active (default): the campaign's customers on its roster now; archived: the customers it has held who are archived since; all: both.","schema":{"description":"active (default): the campaign's customers on its roster now; archived: the customers it has held who are archived since; all: both.","type":"string","enum":["active","archived","all"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceCampaignCustomersListV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/start-estimates/{id}":{"get":{"operationId":"experience.start-estimates.get.v1","summary":"Get start estimates","description":"Deprecated: no successor. The dashboard no longer shows this estimate; the operation stays served until it is retired. Estimate when Experience runs not yet started should start, at current load across Point11: every organization's runs share the same browsers, so a run waits for the ones ahead of it. Pass id organization with runUnitCount (1-1000) for a launch not yet started, or a campaign id for that campaign's runs not yet started. Answers held when Experience is paused for your organization or campaign. The times are an upper bound at current load, not a promise.","deprecated":true,"tags":["experience"],"x-cli-name":"experience-start-estimates-get","x-point11-scope":"experience:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"organization for a launch not yet started, or an Experience campaign's id for its runs not yet started","schema":{"anyOf":[{"type":"string","const":"organization"},{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}],"description":"organization for a launch not yet started, or an Experience campaign's id for its runs not yet started"}},{"name":"runUnitCount","in":"query","required":false,"description":"With id organization, and only then: how many runs the launch would start","schema":{"description":"With id organization, and only then: how many runs the launch would start","type":"integer","minimum":1,"maximum":1000}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceStartEstimatesGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/journeys":{"get":{"operationId":"experience.journeys.list.v1","summary":"List journeys","description":"Deprecated: use experience.journeys.list.v2 (experience_journeys_list_v2), which also lists iPhone Safari journeys; this version answers as if no iPhone Safari journey existed. List Experience journeys (one customer's visit to a website or app), newest first, for one campaign or the whole organization, filtered by outcome, friction, device, search, and segment. Page with nextCursor.","deprecated":true,"tags":["experience"],"x-cli-name":"experience-journeys-list","x-point11-scope":"experience:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Visit groups per page (1–100; default 20). A group holds one journey per device, so a page reads at most 50 groups; pageSize reports the size read","schema":{"default":20,"description":"Visit groups per page (1–100; default 20). A group holds one journey per device, so a page reads at most 50 groups; pageSize reports the size read","type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor or previousCursor by another page","schema":{"description":"Opaque cursor returned as nextCursor or previousCursor by another page","type":"string","minLength":1,"maxLength":1024,"pattern":"^(after|before):([A-Za-z0-9_-]{1,1024})$"}},{"name":"campaignId","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},{"name":"destinationFingerprint","in":"query","required":false,"description":"One campaign website: an id from experience_campaigns_get_v3's destinations; absent or null is every website","schema":{"description":"One campaign website: an id from experience_campaigns_get_v3's destinations; absent or null is every website","anyOf":[{"type":"string","minLength":1,"maxLength":2000},{"type":"null"}]}},{"name":"window","in":"query","required":false,"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"from":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"to":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["from","to"],"additionalProperties":false},{"type":"null"}]}}}},{"name":"segments","in":"query","required":false,"content":{"application/json":{"schema":{"default":[],"type":"array","items":{"type":"object","properties":{"axis":{"type":"string","enum":["audience","channel","market","age","householdIncome","education","lifeStage","areaType","companySize","buyerRole","seniority","occupation","job","triggerType","intentStage","language","gender","store","customer","agent"]},"id":{"type":"string","minLength":1,"maxLength":200}},"required":["axis","id"],"additionalProperties":false}}}}},{"name":"search","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":2000}},{"name":"outcome","in":"query","required":false,"description":"achieved and not-achieved are a pass and a fail; unavailable is every settled visit with neither verdict (unscored, could not tell, or limited evidence), of which unscored and limited are the narrower parts","schema":{"default":"all","description":"achieved and not-achieved are a pass and a fail; unavailable is every settled visit with neither verdict (unscored, could not tell, or limited evidence), of which unscored and limited are the narrower parts","type":"string","enum":["all","achieved","not-achieved","unavailable","unscored","limited"]}},{"name":"friction","in":"query","required":false,"schema":{"default":false,"type":"boolean"}},{"name":"device","in":"query","required":false,"schema":{"anyOf":[{"type":"string","enum":["desktop","mobile"]},{"type":"null"}]}},{"name":"sort","in":"query","required":false,"content":{"application/json":{"schema":{"default":{"id":"completedAt","desc":true},"type":"object","properties":{"id":{"type":"string","enum":["customer","mobile","desktop","completedAt"]},"desc":{"type":"boolean"}},"required":["id","desc"],"additionalProperties":false}}}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceJourneysListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/journeys-v2":{"get":{"operationId":"experience.journeys.list.v2","summary":"List journeys (v2)","description":"Deprecated: use experience.journeys.list.v3 (experience_journeys_list_v3), whose journey stages also name a screen the evaluator found uncertain (tone uncertain); this version answers such a screen with no tone. List Experience journeys (one customer's visit to a website or app), newest first, for one campaign or the whole organization, filtered by outcome, friction, device, search, and segment. Page with nextCursor.","deprecated":true,"tags":["experience"],"x-cli-name":"experience-journeys-list-v2","x-point11-scope":"experience:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Visit groups per page (1–100; default 20). A group holds one journey per device, so a page reads at most 33 groups; pageSize reports the size read","schema":{"default":20,"description":"Visit groups per page (1–100; default 20). A group holds one journey per device, so a page reads at most 33 groups; pageSize reports the size read","type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor or previousCursor by another page","schema":{"description":"Opaque cursor returned as nextCursor or previousCursor by another page","type":"string","minLength":1,"maxLength":1024,"pattern":"^(after|before):([A-Za-z0-9_-]{1,1024})$"}},{"name":"campaignId","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},{"name":"destinationFingerprint","in":"query","required":false,"description":"One campaign website: an id from experience_campaigns_get_v3's destinations; absent or null is every website","schema":{"description":"One campaign website: an id from experience_campaigns_get_v3's destinations; absent or null is every website","anyOf":[{"type":"string","minLength":1,"maxLength":2000},{"type":"null"}]}},{"name":"window","in":"query","required":false,"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"from":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"to":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["from","to"],"additionalProperties":false},{"type":"null"}]}}}},{"name":"segments","in":"query","required":false,"content":{"application/json":{"schema":{"default":[],"type":"array","items":{"type":"object","properties":{"axis":{"type":"string","enum":["audience","channel","market","age","householdIncome","education","lifeStage","areaType","companySize","buyerRole","seniority","occupation","job","triggerType","intentStage","language","gender","store","customer","agent"]},"id":{"type":"string","minLength":1,"maxLength":200}},"required":["axis","id"],"additionalProperties":false}}}}},{"name":"search","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":2000}},{"name":"outcome","in":"query","required":false,"description":"achieved and not-achieved are a pass and a fail; unavailable is every settled visit with neither verdict (unscored, could not tell, or limited evidence), of which unscored and limited are the narrower parts","schema":{"default":"all","description":"achieved and not-achieved are a pass and a fail; unavailable is every settled visit with neither verdict (unscored, could not tell, or limited evidence), of which unscored and limited are the narrower parts","type":"string","enum":["all","achieved","not-achieved","unavailable","unscored","limited"]}},{"name":"friction","in":"query","required":false,"schema":{"default":false,"type":"boolean"}},{"name":"device","in":"query","required":false,"schema":{"anyOf":[{"type":"string","enum":["desktop","mobile","ios_safari"]},{"type":"null"}]}},{"name":"sort","in":"query","required":false,"content":{"application/json":{"schema":{"default":{"id":"completedAt","desc":true},"type":"object","properties":{"id":{"type":"string","enum":["customer","desktop","mobile","ios_safari","completedAt"]},"desc":{"type":"boolean"}},"required":["id","desc"],"additionalProperties":false}}}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceJourneysListV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/journeys-v3":{"get":{"operationId":"experience.journeys.list.v3","summary":"List journeys (v3)","description":"Deprecated: use experience.journeys.list.v4 (experience_journeys_list_v4), whose journeys' recording.thumbnailArtifactId names the journey's stored thumbnail (kind thumbnail), null until it is stored; this version names the first stored screenshot, full size, as it did. List Experience journeys (one customer's visit to a website or app), newest first, for one campaign or the whole organization, filtered by outcome, friction, device, search, and segment. Each journey's recording stages carry the evaluator's tone for each captured screen: progress, friction, uncertain, failed, or none when not assessed. Page with nextCursor.","deprecated":true,"tags":["experience"],"x-cli-name":"experience-journeys-list-v3","x-point11-scope":"experience:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Visit groups per page (1–100; default 20). A group holds one journey per device, so a page reads at most 33 groups; pageSize reports the size read","schema":{"default":20,"description":"Visit groups per page (1–100; default 20). A group holds one journey per device, so a page reads at most 33 groups; pageSize reports the size read","type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor or previousCursor by another page","schema":{"description":"Opaque cursor returned as nextCursor or previousCursor by another page","type":"string","minLength":1,"maxLength":1024,"pattern":"^(after|before):([A-Za-z0-9_-]{1,1024})$"}},{"name":"campaignId","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},{"name":"destinationFingerprint","in":"query","required":false,"description":"One campaign website: an id from experience_campaigns_get_v3's destinations; absent or null is every website","schema":{"description":"One campaign website: an id from experience_campaigns_get_v3's destinations; absent or null is every website","anyOf":[{"type":"string","minLength":1,"maxLength":2000},{"type":"null"}]}},{"name":"window","in":"query","required":false,"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"from":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"to":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["from","to"],"additionalProperties":false},{"type":"null"}]}}}},{"name":"segments","in":"query","required":false,"content":{"application/json":{"schema":{"default":[],"type":"array","items":{"type":"object","properties":{"axis":{"type":"string","enum":["audience","channel","market","age","householdIncome","education","lifeStage","areaType","companySize","buyerRole","seniority","occupation","job","triggerType","intentStage","language","gender","store","customer","agent"]},"id":{"type":"string","minLength":1,"maxLength":200}},"required":["axis","id"],"additionalProperties":false}}}}},{"name":"search","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":2000}},{"name":"outcome","in":"query","required":false,"description":"achieved and not-achieved are a pass and a fail; unavailable is every settled visit with neither verdict (unscored, could not tell, or limited evidence), of which unscored and limited are the narrower parts","schema":{"default":"all","description":"achieved and not-achieved are a pass and a fail; unavailable is every settled visit with neither verdict (unscored, could not tell, or limited evidence), of which unscored and limited are the narrower parts","type":"string","enum":["all","achieved","not-achieved","unavailable","unscored","limited"]}},{"name":"friction","in":"query","required":false,"schema":{"default":false,"type":"boolean"}},{"name":"device","in":"query","required":false,"schema":{"anyOf":[{"type":"string","enum":["desktop","mobile","ios_safari"]},{"type":"null"}]}},{"name":"sort","in":"query","required":false,"content":{"application/json":{"schema":{"default":{"id":"completedAt","desc":true},"type":"object","properties":{"id":{"type":"string","enum":["customer","desktop","mobile","ios_safari","completedAt"]},"desc":{"type":"boolean"}},"required":["id","desc"],"additionalProperties":false}}}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceJourneysListV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/journeys-v4":{"get":{"operationId":"experience.journeys.list.v4","summary":"List journeys (v4)","description":"Deprecated: use experience.journeys.list.v5 (experience_journeys_list_v5), whose journeys' recording.thumbnailArtifactId names the journey's small thumbnail (kind small_thumbnail), sized for a list row; this version names its thumbnail (kind thumbnail), sized for the campaign overview's replay card, as it did. List Experience journeys (one customer's visit to a website or app), newest first, for one campaign or the whole organization, filtered by website, outcome, friction, device, search, and segment. Each journey's recording stages carry the evaluator's tone for each captured screen: progress, friction, uncertain, failed, or none when not assessed. Page with nextCursor.","deprecated":true,"tags":["experience"],"x-cli-name":"experience-journeys-list-v4","x-point11-scope":"experience:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Visit groups per page (1–100; default 20). A group holds one journey per device, so a page reads at most 33 groups; pageSize reports the size read","schema":{"default":20,"description":"Visit groups per page (1–100; default 20). A group holds one journey per device, so a page reads at most 33 groups; pageSize reports the size read","type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor or previousCursor by another page","schema":{"description":"Opaque cursor returned as nextCursor or previousCursor by another page","type":"string","minLength":1,"maxLength":1024,"pattern":"^(after|before):([A-Za-z0-9_-]{1,1024})$"}},{"name":"campaignId","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},{"name":"destinationFingerprint","in":"query","required":false,"description":"One campaign website: an id from experience_campaigns_get_v3's destinations; absent or null is every website","schema":{"description":"One campaign website: an id from experience_campaigns_get_v3's destinations; absent or null is every website","anyOf":[{"type":"string","minLength":1,"maxLength":2000},{"type":"null"}]}},{"name":"window","in":"query","required":false,"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"from":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"to":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["from","to"],"additionalProperties":false},{"type":"null"}]}}}},{"name":"segments","in":"query","required":false,"content":{"application/json":{"schema":{"default":[],"type":"array","items":{"type":"object","properties":{"axis":{"type":"string","enum":["audience","channel","market","age","householdIncome","education","lifeStage","areaType","companySize","buyerRole","seniority","occupation","job","triggerType","intentStage","language","gender","store","customer","agent"]},"id":{"type":"string","minLength":1,"maxLength":200}},"required":["axis","id"],"additionalProperties":false}}}}},{"name":"search","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":2000}},{"name":"outcome","in":"query","required":false,"description":"achieved and not-achieved are a pass and a fail; unavailable is every settled visit with neither verdict (unscored, could not tell, or limited evidence), of which unscored and limited are the narrower parts","schema":{"default":"all","description":"achieved and not-achieved are a pass and a fail; unavailable is every settled visit with neither verdict (unscored, could not tell, or limited evidence), of which unscored and limited are the narrower parts","type":"string","enum":["all","achieved","not-achieved","unavailable","unscored","limited"]}},{"name":"friction","in":"query","required":false,"schema":{"default":false,"type":"boolean"}},{"name":"device","in":"query","required":false,"schema":{"anyOf":[{"type":"string","enum":["desktop","mobile","ios_safari"]},{"type":"null"}]}},{"name":"sort","in":"query","required":false,"content":{"application/json":{"schema":{"default":{"id":"completedAt","desc":true},"type":"object","properties":{"id":{"type":"string","enum":["customer","desktop","mobile","ios_safari","completedAt"]},"desc":{"type":"boolean"}},"required":["id","desc"],"additionalProperties":false}}}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceJourneysListV4Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/journeys-v5":{"get":{"operationId":"experience.journeys.list.v5","summary":"List journeys (v5)","description":"List Experience journeys (one customer's visit to a website or app), newest first, for one campaign or the whole organization, filtered by website, outcome, friction, device, search, and segment. Each journey's recording stages carry the evaluator's tone for each captured screen: progress, friction, uncertain, failed, or none when not assessed, and its recording.thumbnailArtifactId names its small stored preview, sized for a list row, which experience_run_artifacts_download_v3 downloads. Page with nextCursor.","tags":["experience"],"x-cli-name":"experience-journeys-list-v5","x-point11-scope":"experience:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Visit groups per page (1–100; default 20). A group holds one journey per device, so a page reads at most 33 groups; pageSize reports the size read","schema":{"default":20,"description":"Visit groups per page (1–100; default 20). A group holds one journey per device, so a page reads at most 33 groups; pageSize reports the size read","type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor or previousCursor by another page","schema":{"description":"Opaque cursor returned as nextCursor or previousCursor by another page","type":"string","minLength":1,"maxLength":1024,"pattern":"^(after|before):([A-Za-z0-9_-]{1,1024})$"}},{"name":"campaignId","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},{"name":"destinationFingerprint","in":"query","required":false,"description":"One campaign website: an id from experience_campaigns_get_v3's destinations; absent or null is every website","schema":{"description":"One campaign website: an id from experience_campaigns_get_v3's destinations; absent or null is every website","anyOf":[{"type":"string","minLength":1,"maxLength":2000},{"type":"null"}]}},{"name":"window","in":"query","required":false,"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"from":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"to":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["from","to"],"additionalProperties":false},{"type":"null"}]}}}},{"name":"segments","in":"query","required":false,"content":{"application/json":{"schema":{"default":[],"type":"array","items":{"type":"object","properties":{"axis":{"type":"string","enum":["audience","channel","market","age","householdIncome","education","lifeStage","areaType","companySize","buyerRole","seniority","occupation","job","triggerType","intentStage","language","gender","store","customer","agent"]},"id":{"type":"string","minLength":1,"maxLength":200}},"required":["axis","id"],"additionalProperties":false}}}}},{"name":"search","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":2000}},{"name":"outcome","in":"query","required":false,"description":"achieved and not-achieved are a pass and a fail; unavailable is every settled visit with neither verdict (unscored, could not tell, or limited evidence), of which unscored and limited are the narrower parts","schema":{"default":"all","description":"achieved and not-achieved are a pass and a fail; unavailable is every settled visit with neither verdict (unscored, could not tell, or limited evidence), of which unscored and limited are the narrower parts","type":"string","enum":["all","achieved","not-achieved","unavailable","unscored","limited"]}},{"name":"friction","in":"query","required":false,"schema":{"default":false,"type":"boolean"}},{"name":"device","in":"query","required":false,"schema":{"anyOf":[{"type":"string","enum":["desktop","mobile","ios_safari"]},{"type":"null"}]}},{"name":"sort","in":"query","required":false,"content":{"application/json":{"schema":{"default":{"id":"completedAt","desc":true},"type":"object","properties":{"id":{"type":"string","enum":["customer","desktop","mobile","ios_safari","completedAt"]},"desc":{"type":"boolean"}},"required":["id","desc"],"additionalProperties":false}}}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceJourneysListV5Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/journeys/{id}":{"get":{"operationId":"experience.journeys.get.v1","summary":"Get journeys","description":"Deprecated: use experience.journeys.get.v2 (experience_journeys_get_v2), which also reads iPhone Safari journeys; this version answers as if none existed, so one is not found. A journey whose scored verdict cites a step past 120 is not found either, though navigation may still name one. Get one Experience journey's replay by run id: every recorded step with its screenshot, the shopper's reasoning, narration, and the scored verdict (achieved, not achieved, or could not tell). Media URLs are short-lived. Set navigation to also read the journey's place among its campaign's recordings.","deprecated":true,"tags":["experience"],"x-cli-name":"experience-journeys-get","x-point11-scope":"experience:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":200}},{"name":"navigation","in":"query","required":false,"description":"Also read the journey's place among its campaign's recordings (navigation); null when false","schema":{"default":false,"description":"Also read the journey's place among its campaign's recordings (navigation); null when false","type":"boolean"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceJourneysGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/journeys-v2/{id}":{"get":{"operationId":"experience.journeys.get.v2","summary":"Get journeys (v2)","description":"Deprecated: use experience.journeys.get.v3 (experience_journeys_get_v3), which also reads a journey whose scored verdict cites a step past 120; this version answers as if none existed, so one is not found, though navigation may still name one. Get one Experience journey's replay by run id: every recorded step with its screenshot, the shopper's reasoning, narration, and the scored verdict (achieved, not achieved, or could not tell). Media URLs are short-lived. Set navigation to also read the journey's place among its campaign's recordings.","deprecated":true,"tags":["experience"],"x-cli-name":"experience-journeys-get-v2","x-point11-scope":"experience:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":200}},{"name":"navigation","in":"query","required":false,"description":"Also read the journey's place among its campaign's recordings (navigation); null when false","schema":{"default":false,"description":"Also read the journey's place among its campaign's recordings (navigation); null when false","type":"boolean"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceJourneysGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/journeys-v3/{id}":{"get":{"operationId":"experience.journeys.get.v3","summary":"Get journeys (v3)","description":"Get one Experience journey's replay by run id: every recorded step with its screenshot, the shopper's reasoning, narration, and the scored verdict (achieved, not achieved, or could not tell), which may cite any step the visit recorded. Media URLs are short-lived. Set navigation to also read the journey's place among its campaign's recordings.","tags":["experience"],"x-cli-name":"experience-journeys-get-v3","x-point11-scope":"experience:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":200}},{"name":"navigation","in":"query","required":false,"description":"Also read the journey's place among its campaign's recordings (navigation); null when false","schema":{"default":false,"description":"Also read the journey's place among its campaign's recordings (navigation); null when false","type":"boolean"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceJourneysGetV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/customer-journeys":{"get":{"operationId":"experience.customer-journeys.list.v1","summary":"List customer journeys","description":"Deprecated: use experience.customer-journeys.list.v2 (experience_customer_journeys_list_v2), which also lists iPhone Safari journeys; this version answers as if no iPhone Safari journey existed. List one customer's Experience journeys, newest first, from every campaign and from runs outside one, each with its campaign, device, and status. Read a journey's recording with experience_journeys_get. A customer your organization deleted, or does not have, is not found. Page with nextCursor.","deprecated":true,"tags":["experience"],"x-cli-name":"experience-customer-journeys-list","x-point11-scope":"experience:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"customerId","in":"query","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceCustomerJourneysListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/customer-journeys-v2":{"get":{"operationId":"experience.customer-journeys.list.v2","summary":"List customer journeys (v2)","description":"List one customer's Experience journeys, newest first, from every campaign and from runs outside one, each with its campaign, device, and status. Read a journey's recording with experience_journeys_get_v3. A customer your organization deleted, or does not have, is not found. Page with nextCursor.","tags":["experience"],"x-cli-name":"experience-customer-journeys-list-v2","x-point11-scope":"experience:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"customerId","in":"query","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceCustomerJourneysListV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/run-artifacts/download":{"get":{"operationId":"experience.run-artifacts.download.v1","summary":"Download run artifacts","description":"Deprecated: use experience.run-artifacts.download.v2 (experience_run_artifacts_download_v2), which also names a journey's thumbnail (kind thumbnail); this version answers a thumbnail as the screenshot it previews. Download one media file a journey recorded (a step screenshot, the narration audio, or the shopper's portrait) by its run id and artifact id from experience_journeys_get_v2. Returns the file's name, type and size with a short-lived URL to GET its bytes; call again for a fresh URL.","deprecated":true,"tags":["experience"],"x-cli-name":"experience-run-artifacts-download","x-point11-scope":"experience:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"runId","in":"query","required":true,"description":"The journey's run id","schema":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The journey's run id"}},{"name":"id","in":"query","required":true,"description":"The artifact id the journey's replay names","schema":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The artifact id the journey's replay names"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceRunArtifactsDownloadResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/run-artifacts/download-v2":{"get":{"operationId":"experience.run-artifacts.download.v2","summary":"Download run artifacts (v2)","description":"Deprecated: use experience.run-artifacts.download.v3 (experience_run_artifacts_download_v3), which also names a journey's small thumbnail (kind small_thumbnail); this version answers a small thumbnail as kind thumbnail. Download one media file a journey recorded (a step screenshot, the journey's thumbnail, the narration audio, or the shopper's portrait) by its run id and artifact id: a replay frame from experience_journeys_get_v2, or a journey's recording.thumbnailArtifactId from experience_journeys_list_v4, experience_campaign_overview_get_v7's replayJourneys, or experience_campaign_analytics_get_v9's panels. Returns the file's name, type and size with a short-lived URL to GET its bytes; call again for a fresh URL.","deprecated":true,"tags":["experience"],"x-cli-name":"experience-run-artifacts-download-v2","x-point11-scope":"experience:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"runId","in":"query","required":true,"description":"The journey's run id","schema":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The journey's run id"}},{"name":"id","in":"query","required":true,"description":"The artifact id the journey's replay names","schema":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The artifact id the journey's replay names"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceRunArtifactsDownloadV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/run-artifacts/download-v3":{"get":{"operationId":"experience.run-artifacts.download.v3","summary":"Download run artifacts (v3)","description":"Download one media file a journey recorded (a step screenshot, the journey's thumbnail or small thumbnail, the narration audio, or the shopper's portrait) by its run id and artifact id: a replay frame from experience_journeys_get_v3, a journey's recording.thumbnailArtifactId from experience_journeys_list_v5 (its small thumbnail), or from experience_campaign_overview_get_v7's replayJourneys or experience_campaign_analytics_get_v9's panels (its thumbnail). Returns the file's name, type and size with a short-lived URL to GET its bytes; call again for a fresh URL.","tags":["experience"],"x-cli-name":"experience-run-artifacts-download-v3","x-point11-scope":"experience:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"runId","in":"query","required":true,"description":"The journey's run id","schema":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The journey's run id"}},{"name":"id","in":"query","required":true,"description":"The artifact id the journey's replay names","schema":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The artifact id the journey's replay names"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceRunArtifactsDownloadV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/journeys/export":{"get":{"operationId":"experience.journeys.export.v1","summary":"Export journeys","description":"Export one Experience journey by run id as the files of an archive: report.md (the customer, when they visited, the goal and outcome, every captured screen's timestamp, color and findings, and the transcript), the narration audio, and every captured screen. Each recorded file carries a short-lived url that GETs its bytes; the report carries its content inline. Unknown or foreign run → not found.","tags":["experience"],"x-cli-name":"experience-journeys-export","x-point11-scope":"experience:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"query","required":true,"description":"The journey's run id","schema":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The journey's run id"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceJourneysExportResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/connections":{"get":{"operationId":"experience.connections.list.v1","summary":"List connections","description":"List the websites and apps your organization connected for Experience, newest first, optionally for one business profile or status. Page with nextCursor.","tags":["experience"],"x-cli-name":"experience-connections-list","x-point11-scope":"experience:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"businessProfileId","in":"query","required":false,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["active","revoked"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceConnectionsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/connections/{id}":{"get":{"operationId":"experience.connections.get.v1","summary":"Get connections","description":"Get one connected website or app by id, with its access policy and its test accounts (never their credentials).","tags":["experience"],"x-cli-name":"experience-connections-get","x-point11-scope":"experience:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceConnectionsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/connections/create":{"post":{"operationId":"experience.connections.create.v1","summary":"Create connections","description":"Connect a website or native app for Experience journeys under a business profile, with its environment, approved origins, and signed-in access settings. Keep test and production in separate connections.","tags":["experience"],"x-cli-name":"experience-connections-create","x-point11-scope":"experience:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceConnectionsCreateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceConnectionsCreateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/connections/update":{"post":{"operationId":"experience.connections.update.v1","summary":"Update connections","description":"Update a connected website or app. Pass the revision you read; a stale revision is refused so you can read it again.","tags":["experience"],"x-cli-name":"experience-connections-update","x-point11-scope":"experience:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceConnectionsUpdateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceConnectionsUpdateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/connections/revoke":{"post":{"operationId":"experience.connections.revoke.v1","summary":"Revoke connections","description":"Revoke a connected website or app so no further journeys sign in to it. Pass the revision you read. This cannot be undone.","tags":["experience"],"x-cli-name":"experience-connections-revoke","x-point11-scope":"experience:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceConnectionsRevokeRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceConnectionsRevokeResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/connections/verify-domain":{"post":{"operationId":"experience.connections.verify-domain.v1","summary":"Verify domain connections","description":"Check that your organization controls every host a connected website approves, and record the answer on the connection. A host is proven by a domain your organization verified for single sign-on (it or a parent of it), or by the TXT record the connection's domainVerification.record names, published at the host or a parent domain. Until every host is proven, journeys treat the website as one you do not own: robots.txt and the full site fence, no test actions, no sign-in, no iPhone Safari. A record that is not there yet answers verified false with the hosts left; a DNS or single sign-on lookup that does not answer is retryable and records nothing. Pass the revision you read; verifying does not change it.","tags":["experience"],"x-cli-name":"experience-connections-verify-domain","x-point11-scope":"experience:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceConnectionsVerifyDomainRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceConnectionsVerifyDomainResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/test-accounts":{"get":{"operationId":"experience.test-accounts.list.v1","summary":"List test accounts","description":"List the test accounts available to Experience journeys for one business profile, with whether each is ready to sign in. Never returns credentials. Page with nextCursor.","tags":["experience"],"x-cli-name":"experience-test-accounts-list","x-point11-scope":"experience:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"businessProfileId","in":"query","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceTestAccountsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/test-accounts/create":{"post":{"operationId":"experience.test-accounts.create.v1","summary":"Create test accounts","description":"Add a test account to a connected website or app, signed in by password or by a recorded browser sign-in. Then save its password or start its browser sign-in.","tags":["experience"],"x-cli-name":"experience-test-accounts-create","x-point11-scope":"experience:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceTestAccountsCreateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceTestAccountsCreateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/test-accounts/save-password":{"post":{"operationId":"experience.test-accounts.save-password.v1","summary":"Save password test accounts","description":"Store a test account's username, password, and optional TOTP secret in secure storage. They are write-only: no read ever returns them.","tags":["experience"],"x-cli-name":"experience-test-accounts-save-password","x-point11-scope":"experience:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceTestAccountsSavePasswordRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceTestAccountsSavePasswordResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/test-accounts/revoke":{"post":{"operationId":"experience.test-accounts.revoke.v1","summary":"Revoke test accounts","description":"Revoke a test account and delete its stored credentials. Pass the revision you read. This cannot be undone.","tags":["experience"],"x-cli-name":"experience-test-accounts-revoke","x-point11-scope":"experience:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceTestAccountsRevokeRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceTestAccountsRevokeResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/test-accounts/start-browser-enrollment":{"post":{"operationId":"experience.test-accounts.start-browser-enrollment.v1","summary":"Start browser enrollment test accounts","description":"Open a live browser for a person to sign in to a test account once. Returns a live-view URL a human must open; then call experience_test_accounts_finish_browser_enrollment.","tags":["experience"],"x-cli-name":"experience-test-accounts-start-browser-enrollment","x-point11-scope":"experience:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceTestAccountsStartBrowserEnrollmentRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceTestAccountsStartBrowserEnrollmentResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/test-accounts/finish-browser-enrollment":{"post":{"operationId":"experience.test-accounts.finish-browser-enrollment.v1","summary":"Finish browser enrollment test accounts","description":"Save the signed-in browser a person completed for a test account, then verify that it still reaches the signed-in pages. A failed check is reported on the account.","tags":["experience"],"x-cli-name":"experience-test-accounts-finish-browser-enrollment","x-point11-scope":"experience:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceTestAccountsFinishBrowserEnrollmentRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceTestAccountsFinishBrowserEnrollmentResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/test-accounts/verify-browser-access":{"post":{"operationId":"experience.test-accounts.verify-browser-access.v1","summary":"Verify browser access test accounts","description":"Check that a test account can still sign in to its website. The outcome, including a failure, is recorded on the account.","tags":["experience"],"x-cli-name":"experience-test-accounts-verify-browser-access","x-point11-scope":"experience:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceTestAccountsVerifyBrowserAccessRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceTestAccountsVerifyBrowserAccessResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/test-accounts/verify-app-access":{"post":{"operationId":"experience.test-accounts.verify-app-access.v1","summary":"Verify app access test accounts","description":"Check that a test account can sign in to an uploaded app version on a chosen device (see experience_native_devices_list). The outcome, including a failure, is recorded on the account.","tags":["experience"],"x-cli-name":"experience-test-accounts-verify-app-access","x-point11-scope":"experience:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceTestAccountsVerifyAppAccessRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceTestAccountsVerifyAppAccessResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/app-builds":{"get":{"operationId":"experience.app-builds.list.v1","summary":"List app builds","description":"List the uploaded versions of a connected native app, newest first, with their upload status. Page with nextCursor.","tags":["experience"],"x-cli-name":"experience-app-builds-list","x-point11-scope":"experience:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"connectionId","in":"query","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceAppBuildsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/app-builds/reserve-upload":{"post":{"operationId":"experience.app-builds.reserve-upload.v1","summary":"Reserve upload app builds","description":"Reserve an upload of one app version (an iOS .ipa, or an Android .apk, .aab or .xapk) and get a short-lived upload URL. PUT the file to it, then call experience_app_builds_complete_upload with the returned ETag. A version the app already has on that platform, verified or with its upload link still open, is refused.","tags":["experience"],"x-cli-name":"experience-app-builds-reserve-upload","x-point11-scope":"experience:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceAppBuildsReserveUploadRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceAppBuildsReserveUploadResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/app-builds/complete-upload":{"post":{"operationId":"experience.app-builds.complete-upload.v1","summary":"Complete upload app builds","description":"Verify and save an app version after its file was uploaded to the reserved URL. Retrying with the same build id is safe.","tags":["experience"],"x-cli-name":"experience-app-builds-complete-upload","x-point11-scope":"experience:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceAppBuildsCompleteUploadRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceAppBuildsCompleteUploadResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/app-builds/recover-upload":{"post":{"operationId":"experience.app-builds.recover-upload.v1","summary":"Recover upload app builds","description":"Check an app version whose upload finished but was never confirmed, and save it if the file is complete.","tags":["experience"],"x-cli-name":"experience-app-builds-recover-upload","x-point11-scope":"experience:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceAppBuildsRecoverUploadRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceAppBuildsRecoverUploadResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/app-builds/delete":{"post":{"operationId":"experience.app-builds.delete.v1","summary":"Delete app builds","description":"Delete an app version whose upload was never verified, with any file that reached it, from the app's version list. Allowed once its uploadExpiresAt has passed, when it already no longer holds its version label; a verified version cannot be deleted. If its file cannot be confirmed gone, the version stays listed with deletionPending and deleting it again finishes. Returns the deleted version.","tags":["experience"],"x-cli-name":"experience-app-builds-delete","x-point11-scope":"experience:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceAppBuildsDeleteRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceAppBuildsDeleteResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/native-devices":{"get":{"operationId":"experience.native-devices.list.v1","summary":"List native devices","description":"List the real mobile devices available for verifying a test account's app sign-in. Page with nextCursor.","tags":["experience"],"x-cli-name":"experience-native-devices-list","x-point11-scope":"experience:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceNativeDevicesListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/diagnostic-sessions/start":{"post":{"operationId":"experience.diagnostic-sessions.start.v1","summary":"Start diagnostic sessions","description":"Alpha's site test tool, for an Alpha turn only: any other caller (an API key, a dashboard session, an OAuth client, another agent) is refused 403 AUTH_FORBIDDEN. Point11's shopper opens url (a page on one of the organization's own websites, on desktop or a phone) in a real browser, tries task, and the scorer judges it against criteria. It binds no customer or campaign, enters no Experience figure, only looks (never signs in, buys or submits a form), and draws no credits. Returns testId at once, or a refusal (outside_site, unsafe, unavailable); the test takes minutes: read it with experience_diagnostic_sessions_get. The same Idempotency-Key answers the same testId.","tags":["experience"],"x-cli-name":"experience-diagnostic-sessions-start","x-point11-scope":"experience:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceDiagnosticSessionsStartRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceDiagnosticSessionsStartResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/experience/diagnostic-sessions/{id}":{"get":{"operationId":"experience.diagnostic-sessions.get.v1","summary":"Get diagnostic sessions","description":"Read one browser test experience_diagnostic_sessions_start started, by its testId: running; settled with the scorer's verdict against its criteria (pass, fail or could_not_tell, whom a fail blames, why, and the shopper's own step notes); or failed, which says why the test could not run and is never a verdict about the site.","tags":["experience"],"x-cli-name":"experience-diagnostic-sessions-get","x-point11-scope":"experience:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The testId the start returned.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The testId the start returned."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceDiagnosticSessionsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/sites/sites":{"get":{"operationId":"sites.sites.list.v1","summary":"List sites","description":"List your organization's hosted Sites with their template, status, custom domain, and attached Chat and Voice agents. Page with nextCursor.","tags":["sites"],"x-cli-name":"sites-sites-list","x-point11-scope":"sites:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SitesSitesListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/sites/sites/{id}":{"get":{"operationId":"sites.sites.get.v1","summary":"Get sites","description":"Get one hosted Site by site id: template, status, config, embed origins, custom domain, and attached agents.","tags":["sites"],"x-cli-name":"sites-sites-get","x-point11-scope":"sites:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SitesSitesGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/sites/sites/create":{"post":{"operationId":"sites.sites.create.v1","summary":"Create sites","description":"Create a hosted Site from a template with a unique slug, optionally attaching a Chat agent, a Voice agent, and a custom domain registered with sites_domains_create.","tags":["sites"],"x-cli-name":"sites-sites-create","x-point11-scope":"sites:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SitesSitesCreateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SitesSitesCreateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/sites/sites/update":{"post":{"operationId":"sites.sites.update.v1","summary":"Update sites","description":"Change a hosted Site by site id: name, slug, template, status, config, embed origins, custom domain, or attached agents. Send only the fields to change.","tags":["sites"],"x-cli-name":"sites-sites-update","x-point11-scope":"sites:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SitesSitesUpdateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SitesSitesUpdateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/sites/sites/delete":{"post":{"operationId":"sites.sites.delete.v1","summary":"Delete sites","description":"Delete a hosted Site by site id. The Site stops serving; its agents and custom domain remain.","tags":["sites"],"x-cli-name":"sites-sites-delete","x-point11-scope":"sites:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SitesSitesDeleteRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SitesSitesDeleteResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/sites/domains":{"get":{"operationId":"sites.domains.list.v1","summary":"List domains","description":"List your organization's custom domains with their verification token, verification state, and SSL status. Page with nextCursor.","tags":["sites"],"x-cli-name":"sites-domains-list","x-point11-scope":"sites:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SitesDomainsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/sites/domains/create":{"post":{"operationId":"sites.domains.create.v1","summary":"Create domains","description":"Register a custom hostname such as chat.example.com. The result carries a verificationToken to publish as a DNS TXT record before calling sites_domains_verify.","tags":["sites"],"x-cli-name":"sites-domains-create","x-point11-scope":"sites:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SitesDomainsCreateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SitesDomainsCreateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/sites/domains/delete":{"post":{"operationId":"sites.domains.delete.v1","summary":"Delete domains","description":"Remove a custom domain by domain id. A Site using it stops serving on that host.","tags":["sites"],"x-cli-name":"sites-domains-delete","x-point11-scope":"sites:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SitesDomainsDeleteRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SitesDomainsDeleteResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/sites/domains/verify":{"post":{"operationId":"sites.domains.verify.v1","summary":"Verify domains","description":"Check a custom domain's DNS TXT record and mark the domain verified when it is found. A record not found yet is a normal outcome (verified false); DNS changes can take up to 48 hours.","tags":["sites"],"x-cli-name":"sites-domains-verify","x-point11-scope":"sites:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SitesDomainsVerifyRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SitesDomainsVerifyResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/sites/domains/attach":{"post":{"operationId":"sites.domains.attach.v1","summary":"Attach domains","description":"Serve a published Alpha website on a verified custom domain by domain id and any version id of the page (pageId). The page's live version is built again for the domain's own origin before the domain is attached, which can take a few minutes; calling it again moves the domain to the page's live version. The domain must also be added to Point11's hosting before its host answers.","tags":["sites"],"x-cli-name":"sites-domains-attach","x-point11-scope":"sites:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SitesDomainsAttachRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SitesDomainsAttachResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/sites/domains/detach":{"post":{"operationId":"sites.domains.detach.v1","summary":"Detach domains","description":"Stop serving a page on a custom domain by domain id; the domain stays registered and verified.","tags":["sites"],"x-cli-name":"sites-domains-detach","x-point11-scope":"sites:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SitesDomainsDetachRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SitesDomainsDetachResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/agents/agents":{"get":{"operationId":"agents.agents.list.v1","summary":"List agents","description":"Deprecated: use agents.agents.list.v2 (agents_agents_list_v2), which leaves out maxToolSteps, a Chat setting nothing stores; this version answers it as null, unset, for every Chat agent. List your organization's Chat and Voice agent configurations, then the Point11 default agents you have not overridden (source system). Page with nextCursor.","deprecated":true,"tags":["agents"],"x-cli-name":"agents-agents-list","x-point11-scope":"agents:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentsAgentsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/agents/agents-v2":{"get":{"operationId":"agents.agents.list.v2","summary":"List agents (v2)","description":"List your organization's Chat and Voice agent configurations, then the Point11 default agents you have not overridden (source system). Page with nextCursor.","tags":["agents"],"x-cli-name":"agents-agents-list-v2","x-point11-scope":"agents:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentsAgentsListV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/agents/agents/{id}":{"get":{"operationId":"agents.agents.get.v1","summary":"Get agents","description":"Deprecated: use agents.agents.get.v2 (agents_agents_get_v2), which leaves out maxToolSteps, a Chat setting nothing stores; this version answers it as null, unset, for every Chat agent. Get one agent configuration by agent id and agentType (chat or voice); Chat and Voice ids are separate.","deprecated":true,"tags":["agents"],"x-cli-name":"agents-agents-get","x-point11-scope":"agents:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"agentType","in":"query","required":true,"schema":{"type":"string","enum":["chat","voice"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentsAgentsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/agents/agents-v2/{id}":{"get":{"operationId":"agents.agents.get.v2","summary":"Get agents (v2)","description":"Get one agent configuration by agent id and agentType (chat or voice); Chat and Voice ids are separate.","tags":["agents"],"x-cli-name":"agents-agents-get-v2","x-point11-scope":"agents:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"agentType","in":"query","required":true,"schema":{"type":"string","enum":["chat","voice"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentsAgentsGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/agents/agents/create":{"post":{"operationId":"agents.agents.create.v1","summary":"Create agents","description":"Deprecated: use agents.agents.create.v2 (agents_agents_create_v2), which leaves out maxToolSteps, a Chat setting nothing stores; this version answers it as null, unset, for every Chat agent. Create a Chat or Voice agent configuration with a unique slug. A Voice agent is provisioned with its provider in the background; its provisioningOperationId names that work.","deprecated":true,"tags":["agents"],"x-cli-name":"agents-agents-create","x-point11-scope":"agents:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentsAgentsCreateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentsAgentsCreateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/agents/agents/create-v2":{"post":{"operationId":"agents.agents.create.v2","summary":"Create agents (v2)","description":"Create a Chat or Voice agent configuration with a unique slug. A Voice agent is provisioned with its provider in the background; its provisioningOperationId names that work.","tags":["agents"],"x-cli-name":"agents-agents-create-v2","x-point11-scope":"agents:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentsAgentsCreateV2Request"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentsAgentsCreateV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/agents/agents/update":{"post":{"operationId":"agents.agents.update.v1","summary":"Update agents","description":"Deprecated: use agents.agents.update.v2 (agents_agents_update_v2), which leaves out maxToolSteps, a Chat setting nothing stores; this version accepts and ignores it, and answers it as null, unset, for every Chat agent. Change one Chat or Voice agent configuration by agent id and agentType. Send only the fields to change; a Voice change is reconciled with its provider in the background.","deprecated":true,"tags":["agents"],"x-cli-name":"agents-agents-update","x-point11-scope":"agents:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentsAgentsUpdateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentsAgentsUpdateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/agents/agents/update-v2":{"post":{"operationId":"agents.agents.update.v2","summary":"Update agents (v2)","description":"Change one Chat or Voice agent configuration by agent id and agentType. Send only the fields to change; a Voice change is reconciled with its provider in the background.","tags":["agents"],"x-cli-name":"agents-agents-update-v2","x-point11-scope":"agents:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentsAgentsUpdateV2Request"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentsAgentsUpdateV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/agents/agents/delete":{"post":{"operationId":"agents.agents.delete.v1","summary":"Delete agents","description":"Delete a Chat agent or archive a Voice agent by agent id and agentType; an archived Voice agent is disabled with its provider in the background.","tags":["agents"],"x-cli-name":"agents-agents-delete","x-point11-scope":"agents:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentsAgentsDeleteRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentsAgentsDeleteResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/agents/agent-analytics/{id}":{"get":{"operationId":"agents.agent-analytics.get.v1","summary":"Get agent analytics","description":"Get one agent's conversation (Chat) or session (Voice) analytics over a 7d, 30d, or 90d window by agent id and agentType.","tags":["agents"],"x-cli-name":"agents-agent-analytics-get","x-point11-scope":"agents:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"agentType","in":"query","required":true,"schema":{"type":"string","enum":["chat","voice"]}},{"name":"range","in":"query","required":false,"schema":{"default":"30d","type":"string","enum":["7d","30d","90d"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentsAgentAnalyticsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/agents/conversations/{id}":{"get":{"operationId":"agents.conversations.get.v1","summary":"Get conversations","description":"Get one Chat or Voice agent conversation's transcript by conversation id: channel, title, and every message with its role, content, and tool calls. A signed-in member reads only their own conversations; an API key reads any in its organization. Transcripts over 100,000 messages are refused.","tags":["agents"],"x-cli-name":"agents-conversations-get","x-point11-scope":"agents:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentsConversationsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/agents/conversations/export":{"get":{"operationId":"agents.conversations.export.v1","summary":"Export conversations","description":"Export your organization's Chat and Voice conversation history as JSON or CSV, optionally filtered by channel and a since/until window. Exports over 10,000 conversations, 100,000 messages, or 4 MiB are refused; narrow the window and retry. Every export is audited.","tags":["agents"],"x-cli-name":"agents-conversations-export","x-point11-scope":"agents:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"format","in":"query","required":true,"schema":{"type":"string","enum":["json","csv"]}},{"name":"since","in":"query","required":false,"schema":{"type":"string","minLength":1}},{"name":"until","in":"query","required":false,"schema":{"type":"string","minLength":1}},{"name":"channel","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["chat","voice","all"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentsConversationsExportResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/collaboration/comment-threads/sync":{"get":{"operationId":"collaboration.comment-threads.sync.v1","summary":"Sync comment threads","description":"Read the signed-in member's comment threads, newest activity first, up to 50 per call with each thread's opening comment and latest replies. Omit `since` for a page: pass the returned `nextPageCursor` as `pageCursor` for older threads. Keep the returned `cursor` and pass it as `since` later to receive only threads changed since then plus the ids of deleted ones; when `hasMoreChanges` is true, call again with the new `cursor` at once. Pass `surfaceId` and `artifactId` together to read one commented page. Needs a signed-in user: read state is per member, so API keys are refused.","tags":["collaboration"],"x-cli-name":"collaboration-comment-threads-sync","x-point11-scope":"collaboration:read","security":[{"oauth":[]}],"parameters":[{"name":"since","in":"query","required":false,"description":"A previous call's `cursor`: return only threads changed since then","schema":{"description":"A previous call's `cursor`: return only threads changed since then","type":"string","minLength":1,"maxLength":100}},{"name":"pageCursor","in":"query","required":false,"description":"A previous page's `nextPageCursor`: return the next older page","schema":{"description":"A previous page's `nextPageCursor`: return the next older page","type":"string","minLength":1,"maxLength":100}},{"name":"surfaceId","in":"query","required":false,"description":"A commentable page (with artifactId): only its threads","schema":{"description":"A commentable page (with artifactId): only its threads","type":"string","minLength":1,"maxLength":100}},{"name":"artifactId","in":"query","required":false,"description":"The campaign or run the commentable page shows (with surfaceId)","schema":{"description":"The campaign or run the commentable page shows (with surfaceId)","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollaborationCommentThreadsSyncResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/collaboration/comment-threads/{id}":{"get":{"operationId":"collaboration.comment-threads.get.v1","summary":"Get comment threads","description":"Read one comment thread with its comments, mentions, and the invitations its comments sent, as the signed-in member sees it (whether it is unread for them and mentions them). Needs a signed-in user: API keys are refused.","tags":["collaboration"],"x-cli-name":"collaboration-comment-threads-get","x-point11-scope":"collaboration:read","security":[{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The comment thread's id","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The comment thread's id"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollaborationCommentThreadsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/collaboration/comment-threads/count-unread":{"get":{"operationId":"collaboration.comment-threads.count-unread.v1","summary":"Count unread comment threads","description":"Count the signed-in member's unread comment threads and the unread ones that mention them, and say whether the organization has any threads at all. Needs a signed-in user: API keys are refused.","tags":["collaboration"],"x-cli-name":"collaboration-comment-threads-count-unread","x-point11-scope":"collaboration:read","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollaborationCommentThreadsCountUnreadResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/collaboration/comment-threads/list-mentions":{"get":{"operationId":"collaboration.comment-threads.list-mentions.v1","summary":"List mentions comment threads","description":"List the comments that mention the signed-in member, newest first: each comment's author, text and time, the thread it is in (its page, anchor, status, and whether it is unread for the member), and the name of the campaign the thread is about when its product knows one. Deleted comments and threads are left out. Needs a signed-in user: mentions are per member, so API keys are refused.","tags":["collaboration"],"x-cli-name":"collaboration-comment-threads-list-mentions","x-point11-scope":"collaboration:read","security":[{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollaborationCommentThreadsListMentionsResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/collaboration/comment-threads/create":{"post":{"operationId":"collaboration.comment-threads.create.v1","summary":"Create comment threads","description":"Start a comment thread on one anchor of a commentable page (a Discovery overview or sentiment card, or an Experience replay) as the signed-in member, optionally mentioning organization members, who are emailed. Returns the thread and the new comment's id; a retry with the same Idempotency-Key returns the thread its first attempt started. Needs a signed-in user: API keys are refused.","tags":["collaboration"],"x-cli-name":"collaboration-comment-threads-create","x-point11-scope":"collaboration:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollaborationCommentThreadsCreateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollaborationCommentThreadsCreateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/collaboration/comment-threads/reply":{"post":{"operationId":"collaboration.comment-threads.reply.v1","summary":"Reply comment threads","description":"Reply to an open comment thread as the signed-in member, optionally inline under one of its comments and mentioning organization members, who are emailed. A resolved thread must be reopened first. Returns the thread and the new comment's id; a retry with the same Idempotency-Key returns the reply its first attempt posted. Needs a signed-in user: API keys are refused.","tags":["collaboration"],"x-cli-name":"collaboration-comment-threads-reply","x-point11-scope":"collaboration:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollaborationCommentThreadsReplyRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollaborationCommentThreadsReplyResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/collaboration/comment-threads/set-status":{"post":{"operationId":"collaboration.comment-threads.set-status.v1","summary":"Set status comment threads","description":"Resolve a comment thread or reopen a resolved one as the signed-in member. Returns the thread. Needs a signed-in user: API keys are refused.","tags":["collaboration"],"x-cli-name":"collaboration-comment-threads-set-status","x-point11-scope":"collaboration:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollaborationCommentThreadsSetStatusRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollaborationCommentThreadsSetStatusResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/collaboration/comment-threads/mark-read":{"post":{"operationId":"collaboration.comment-threads.mark-read.v1","summary":"Mark read comment threads","description":"Mark a comment thread read for the signed-in member as of now; later replies make it unread again. Needs a signed-in user: API keys are refused.","tags":["collaboration"],"x-cli-name":"collaboration-comment-threads-mark-read","x-point11-scope":"collaboration:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollaborationCommentThreadsMarkReadRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollaborationCommentThreadsMarkReadResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/collaboration/comment-invitations/create":{"post":{"operationId":"collaboration.comment-invitations.create.v1","summary":"Create comment invitations","description":"Invite up to five people named in a comment you wrote into the organization as viewers, with the comment as the invitation message; an address that already belongs to a member mentions them instead, and only a newly mentioned member is emailed. Each address settles on its own (`invited`, `mentioned`, or `failed` with the reason). The user must approve each invitation: it grants organization access. Needs a signed-in user who may invite members.","tags":["collaboration"],"x-cli-name":"collaboration-comment-invitations-create","x-point11-scope":"collaboration:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}},{"name":"Point11-Confirm","in":"header","required":true,"description":"Explicit human confirmation of this operation's effect.","schema":{"type":"string","enum":["true"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollaborationCommentInvitationsCreateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollaborationCommentInvitationsCreateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/collaboration/mentionable-members":{"get":{"operationId":"collaboration.mentionable-members.list.v1","summary":"List mentionable members","description":"List the organization's active members that a comment can mention, by name then email, with each member's id to pass as a mention. For a signed-in caller, `viewer` is the caller as a comment author and whether their comments may invite new people.","tags":["collaboration"],"x-cli-name":"collaboration-mentionable-members-list","x-point11-scope":"collaboration:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollaborationMentionableMembersListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/collaboration/presence/touch":{"post":{"operationId":"collaboration.presence.touch.v1","summary":"Touch presence","description":"Mark the signed-in member as active now on the organization's dashboard for 60 seconds and return who else is active now (the dashboard visible and used within the last 5 minutes), with when to touch again to stay present. Name the browser tab (`tabId`) so that tab's leave (`collaboration_presence_leave`) can end it sooner; once that leave runs, a touch under its id renews nothing, so a tab that comes back touches under a new one. A Point11 operator acting as a member is never shown; they only read. Needs a signed-in user: API keys are refused.","tags":["collaboration"],"x-cli-name":"collaboration-presence-touch","x-point11-scope":"collaboration:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollaborationPresenceTouchRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollaborationPresenceTouchResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/collaboration/presence/leave":{"post":{"operationId":"collaboration.presence.leave.v1","summary":"Leave presence","description":"End the signed-in member's dashboard presence from one browser tab (`tabId`, as its touches named it) when that tab closes, hides or goes idle, so other members stop seeing them as active now within one poll instead of when the entry expires. Another of the member's tabs that touched within the last 60 seconds keeps them present (`left` false). After this leave the tab's id renews nothing, so touch under a new one. A Point11 operator acting as a member was never shown, so their leave does nothing. Needs a signed-in user: API keys are refused.","tags":["collaboration"],"x-cli-name":"collaboration-presence-leave","x-point11-scope":"collaboration:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollaborationPresenceLeaveRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollaborationPresenceLeaveResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/billing/summaries/{id}":{"get":{"operationId":"billing.summaries.get.v1","summary":"Get summaries","description":"Read the organization's billing summary: subscription and its recurring lines, standing and notices, card on file, invoice history, and credit grants. The id is the organization id; invoices page by cursor.","tags":["billing"],"x-cli-name":"billing-summaries-get","x-point11-scope":"billing:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"invoiceCursor","in":"query","required":false,"schema":{"type":"string","minLength":1}},{"name":"creditGrantPage","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":9007199254740991}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingSummariesGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/billing/usage-summaries/{id}":{"get":{"operationId":"billing.usage-summaries.get.v1","summary":"Get usage summaries","description":"Deprecated: use billing.usage-summaries.get.v3 (billing_usage_summaries_get_v3), which drops overageTerms and also itemizes fractional API-dollar usage. This version lists integer-unit offers; its account dollar total still includes every settled charge. It still answers overageTerms, as acceptedAt the instant the funding subscription went live (subscribing is the consent) or null without one, and orderFormReference always null. The id is the organization id.","deprecated":true,"tags":["billing"],"x-cli-name":"billing-usage-summaries-get","x-point11-scope":"billing:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingUsageSummariesGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/billing/usage-summaries-v2/{id}":{"get":{"operationId":"billing.usage-summaries.get.v2","summary":"Get usage summaries (v2)","description":"Deprecated: use billing.usage-summaries.get.v3 (billing_usage_summaries_get_v3), which also itemizes fractional API-dollar usage. This version lists integer-unit offers; its account dollar total still includes every settled charge. The id is the organization id.","deprecated":true,"tags":["billing"],"x-cli-name":"billing-usage-summaries-get-v2","x-point11-scope":"billing:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingUsageSummariesGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/billing/usage-summaries-v3/{id}":{"get":{"operationId":"billing.usage-summaries.get.v3","summary":"Get usage summaries (v3)","description":"Read the organization's usage this billing period: each offer's settled units, including fractional API dollars, allowance position, pending runs, and settled overage, and the overage no invoice has billed yet with the date the next invoice bills it and the unbilled amount that invoices it sooner. Every subscribed account bills usage past the plan on its invoice. The id is the organization id.","tags":["billing"],"x-cli-name":"billing-usage-summaries-get-v3","x-point11-scope":"billing:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingUsageSummariesGetV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/billing/interaction-admissions":{"get":{"operationId":"billing.interaction-admissions.list.v1","summary":"List interaction admissions","description":"Ask Billing what it would answer right now for the next priced interaction of each given price identity: included in the allowance, paid as overage, or refused with its reason and sentence.","tags":["billing"],"x-cli-name":"billing-interaction-admissions-list","x-point11-scope":"billing:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"identities","in":"query","required":true,"schema":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"pattern":"^[^/]+\\/[^/]+$"}}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingInteractionAdmissionsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/billing/billing-details/{id}":{"get":{"operationId":"billing.billing-details.get.v1","summary":"Get billing details","description":"Read who Point11 bills and who receives its billing mail: the legal company name, billing address, invoice email, contact, and PO reference that invoices print, with the revision a save names. The id is the organization id.","tags":["billing"],"x-cli-name":"billing-billing-details-get","x-point11-scope":"billing:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingBillingDetailsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/members":{"get":{"operationId":"account.members.list.v1","summary":"List members","description":"List the organization's members and pending invitations, filtered by an optional name or email query, or to the members with the given userIds (as a record names who made it; invitations then are left out), with each person's role and status and the organization's owner count.","tags":["account"],"x-cli-name":"account-members-list","x-point11-scope":"account:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"query","in":"query","required":false,"description":"Case-insensitive substring of a name or email","schema":{"description":"Case-insensitive substring of a name or email","type":"string","maxLength":200}},{"name":"userIds","in":"query","required":false,"description":"Only the members with these user ids, as a record names who made it; pending invitations, which have no user, are left out","schema":{"description":"Only the members with these user ids, as a record names who made it; pending invitations, which have no user, are left out","minItems":1,"maxItems":1000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountMembersListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/members/delete":{"post":{"operationId":"account.members.delete.v1","summary":"Delete members","description":"Remove a member from the organization. The user must approve. Revokes the API keys and the CRM, Google Ads, Google Analytics and Vercel Web Analytics grants that member created, ends the public links to pages in their own chats, and reports what access remains.","tags":["account"],"x-cli-name":"account-members-delete","x-point11-scope":"account:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}},{"name":"Point11-Confirm","in":"header","required":true,"description":"Explicit human confirmation of this operation's effect.","schema":{"type":"string","enum":["true"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountMembersDeleteRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountMembersDeleteResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/memberships/leave":{"post":{"operationId":"account.memberships.leave.v1","summary":"Leave memberships","description":"Leave the organization: remove the signed-in user's own direct membership. The user must approve. Revokes the organization API keys they can no longer issue and the CRM, Google Ads, Google Analytics and Vercel Web Analytics connections their grant powered, ends the public links to pages in their own chats, and reports each count. The sole owner cannot leave; separate Manager access is unchanged.","tags":["account"],"x-cli-name":"account-memberships-leave","x-point11-scope":"account:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}},{"name":"Point11-Confirm","in":"header","required":true,"description":"Explicit human confirmation of this operation's effect.","schema":{"type":"string","enum":["true"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountMembershipsLeaveRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountMembershipsLeaveResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/partner-access":{"get":{"operationId":"account.partner-access.list.v1","summary":"List partner access","description":"List the partner firms that can work in the organization, and the firms asking for access. Each partner names its Partner ID, when it was given access, and its people: their role at the firm, the access the firm gives them in its clients, and what they can do here now. Each request names who asked, when it lapses, and the people approving it would admit; an owner or admin answers it with account_partner_link_requests_approve or account_partner_link_requests_decline, and removes a partner with account_partner_access_revoke.","tags":["account"],"x-cli-name":"account-partner-access-list","x-point11-scope":"account:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountPartnerAccessListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/partner-access/revoke":{"post":{"operationId":"account.partner-access.revoke.v1","summary":"Revoke partner access","description":"Remove a partner firm's access to the organization by its access id (from account_partner_access_list). The user must approve. Everyone at the firm loses access on their next request, and so does each person who joined the organization through an invitation from its people, unless they now own it; the invitations its people sent here and the API keys they can no longer issue are revoked; the removal is recorded in the organization's and the firm's audit logs. Only the organization's own owners and admins can do this, not the firm's people.","tags":["account"],"x-cli-name":"account-partner-access-revoke","x-point11-scope":"account:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}},{"name":"Point11-Confirm","in":"header","required":true,"description":"Explicit human confirmation of this operation's effect.","schema":{"type":"string","enum":["true"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountPartnerAccessRevokeRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountPartnerAccessRevokeResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/partner-link-requests/decline":{"post":{"operationId":"account.partner-link-requests.decline.v1","summary":"Decline partner link requests","description":"Decline a partner firm's request for access to the organization (from account_partner_access_list). The firm gains nothing and may ask again. The user must approve. Only the organization's own owners and admins can do this.","tags":["account"],"x-cli-name":"account-partner-link-requests-decline","x-point11-scope":"account:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}},{"name":"Point11-Confirm","in":"header","required":true,"description":"Explicit human confirmation of this operation's effect.","schema":{"type":"string","enum":["true"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountPartnerLinkRequestsDeclineRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountPartnerLinkRequestsDeclineResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/partner-management/{id}":{"get":{"operationId":"account.partner-management.get.v1","summary":"Get partner management","description":"Read the organization's account-management partner, by the organization's id: the partner firm it designated, if any, who designated it, when it took effect, and whether the organization's owner or admin designated it here or Point11 recorded the organization's written confirmation. Lists the firms it may designate (partner firms that work in it, or that brought it to Point11) and the standard confirmation a designation acknowledges, with its sha256 for account_partner_management_designate. A designation lets Point11 compensate the firm; it grants no access.","tags":["account"],"x-cli-name":"account-partner-management-get","x-point11-scope":"account:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organization id","schema":{"type":"string","description":"The organization id"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountPartnerManagementGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/partner-management/designate":{"post":{"operationId":"account.partner-management.designate.v1","summary":"Designate partner management","description":"Designate a partner firm (its managerId, from account_partner_management_get) as the organization's account-management partner, acknowledging the standard confirmation by its sha256. It takes effect now and replaces the firm designated before, which Point11 notifies. It lets Point11 compensate the firm, adds no charge, grants no access, purchasing or contracting authority, and can be revoked at any time with account_partner_management_revoke. The user must approve. Only the organization's own owners and admins can do this, not a partner firm's people.","tags":["account"],"x-cli-name":"account-partner-management-designate","x-point11-scope":"account:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}},{"name":"Point11-Confirm","in":"header","required":true,"description":"Explicit human confirmation of this operation's effect.","schema":{"type":"string","enum":["true"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountPartnerManagementDesignateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountPartnerManagementDesignateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/partner-management/revoke":{"post":{"operationId":"account.partner-management.revoke.v1","summary":"Revoke partner management","description":"Revoke the organization's designation of its account-management partner (its id, from account_partner_management_get), from now. Point11 notifies the firm; its access to the organization is unchanged. The user must approve. Only the organization's own owners and admins can do this.","tags":["account"],"x-cli-name":"account-partner-management-revoke","x-point11-scope":"account:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}},{"name":"Point11-Confirm","in":"header","required":true,"description":"Explicit human confirmation of this operation's effect.","schema":{"type":"string","enum":["true"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountPartnerManagementRevokeRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountPartnerManagementRevokeResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/invitations":{"get":{"operationId":"account.invitations.list.v1","summary":"List invitations","description":"List the organization's pending invitations, optionally narrowed to given invitation ids, each with its status (pending, email failed, expired) and expiry.","tags":["account"],"x-cli-name":"account-invitations-list","x-point11-scope":"account:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"ids","in":"query","required":false,"description":"Only these invitation ids","schema":{"description":"Only these invitation ids","minItems":1,"maxItems":50,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountInvitationsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/invitations/create":{"post":{"operationId":"account.invitations.create.v1","summary":"Create invitations","description":"Invite someone to the organization by email at a role at or below the caller's own. The user must approve. Returns the invitation and whether its email was sent.","tags":["account"],"x-cli-name":"account-invitations-create","x-point11-scope":"account:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}},{"name":"Point11-Confirm","in":"header","required":true,"description":"Explicit human confirmation of this operation's effect.","schema":{"type":"string","enum":["true"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountInvitationsCreateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountInvitationsCreateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/invitations/resend":{"post":{"operationId":"account.invitations.resend.v1","summary":"Resend invitations","description":"Send a pending invitation again with a fresh link and expiry. The user must approve. Returns the new invitation and whether its email was sent.","tags":["account"],"x-cli-name":"account-invitations-resend","x-point11-scope":"account:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}},{"name":"Point11-Confirm","in":"header","required":true,"description":"Explicit human confirmation of this operation's effect.","schema":{"type":"string","enum":["true"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountInvitationsResendRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountInvitationsResendResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/invitations/revoke":{"post":{"operationId":"account.invitations.revoke.v1","summary":"Revoke invitations","description":"Revoke a pending invitation so its link stops working. The user must approve.","tags":["account"],"x-cli-name":"account-invitations-revoke","x-point11-scope":"account:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}},{"name":"Point11-Confirm","in":"header","required":true,"description":"Explicit human confirmation of this operation's effect.","schema":{"type":"string","enum":["true"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountInvitationsRevokeRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountInvitationsRevokeResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/organizations/{id}":{"get":{"operationId":"account.organizations.get.v1","summary":"Get organizations","description":"Read the organization's profile: its name, 10-digit organization number, and time zone (null while unset). The id is the organization id.","tags":["account"],"x-cli-name":"account-organizations-get","x-point11-scope":"account:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organization id","schema":{"type":"string","description":"The organization id"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountOrganizationsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/organizations/update":{"post":{"operationId":"account.organizations.update.v1","summary":"Update organizations","description":"Rename the organization or change its time zone. Returns the updated profile.","tags":["account"],"x-cli-name":"account-organizations-update","x-point11-scope":"account:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountOrganizationsUpdateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountOrganizationsUpdateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/ai-inference-settings/{id}":{"get":{"operationId":"account.ai-inference-settings.get.v1","summary":"Get ai inference settings","description":"Read where the organization's AI model calls run, who pays for them and whether any model provider may train on them: the execution target, the data policy, the stored cloud credential's summary (never its secret), and this cycle's calls on that credential. The id is the organization id.","tags":["account"],"x-cli-name":"account-ai-inference-settings-get","x-point11-scope":"account:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountAiInferenceSettingsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/notification-preferences-v2":{"get":{"operationId":"account.notification-preferences.list.v2","summary":"List notification preferences (v2)","description":"Deprecated: use account.notification-preferences.list.v4 (account_notification_preferences_list_v4), which lists every category on every channel. This version lists the signed-in member's own email notification categories it was published with and whether each is on in the current organization, and leaves out Mentions and New members, which replaced its Mentions and new members.","deprecated":true,"tags":["account"],"x-cli-name":"account-notification-preferences-list-v2","x-point11-scope":"account:read","security":[{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountNotificationPreferencesListV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/notification-preferences-v3":{"get":{"operationId":"account.notification-preferences.list.v3","summary":"List notification preferences (v3)","description":"Deprecated: use account.notification-preferences.list.v4 (account_notification_preferences_list_v4), which states each channel's default and names no Teams channel. This version lists the signed-in member's own notification categories and whether each is on by email and in Slack in the current organization; Teams is always off.","deprecated":true,"tags":["account"],"x-cli-name":"account-notification-preferences-list-v3","x-point11-scope":"account:read","security":[{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountNotificationPreferencesListV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/notification-preferences-v4":{"get":{"operationId":"account.notification-preferences.list.v4","summary":"List notification preferences (v4)","description":"List the signed-in member's own notification categories in the current organization: whether each is on by email and in Slack, each channel's default, and whether the channel can deliver here. Each organization the member belongs to keeps its own choices.","tags":["account"],"x-cli-name":"account-notification-preferences-list-v4","x-point11-scope":"account:read","security":[{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountNotificationPreferencesListV4Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/notification-preferences/update":{"post":{"operationId":"account.notification-preferences.update.v1","summary":"Update notification preferences","description":"Deprecated: use account.notification-preferences.update.v2 (account_notification_preferences_update_v2), which names its channel and no Teams channel. This version turns one of the signed-in member's own notification categories on or off, by email unless a channel is named, in the current organization; Teams is always refused. Account, billing, campaign and connector request email cannot be switched off.","deprecated":true,"tags":["account"],"x-cli-name":"account-notification-preferences-update","x-point11-scope":"account:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountNotificationPreferencesUpdateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountNotificationPreferencesUpdateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/notification-preferences/update-v2":{"post":{"operationId":"account.notification-preferences.update.v2","summary":"Update notification preferences (v2)","description":"Turn one of the signed-in member's own notification categories on or off on one channel (email or Slack) in the current organization; each other organization the member belongs to keeps its own choice. Account, billing, campaign and connector request email cannot be switched off.","tags":["account"],"x-cli-name":"account-notification-preferences-update-v2","x-point11-scope":"account:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountNotificationPreferencesUpdateV2Request"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountNotificationPreferencesUpdateV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/audit-log-entries":{"get":{"operationId":"account.audit-log-entries.list.v1","summary":"List audit log entries","description":"List the organization's audit log, oldest first, filtered by text, action, actor, and time range.","tags":["account"],"x-cli-name":"account-audit-log-entries-list","x-point11-scope":"account:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"q","in":"query","required":false,"description":"Text matched against the action or target","schema":{"description":"Text matched against the action or target","type":"string"}},{"name":"action","in":"query","required":false,"description":"Text matched against the action","schema":{"description":"Text matched against the action","type":"string"}},{"name":"actor","in":"query","required":false,"description":"Text matched against the actor","schema":{"description":"Text matched against the actor","type":"string"}},{"name":"from","in":"query","required":false,"description":"Earliest entry time, inclusive (ISO 8601)","schema":{"description":"Earliest entry time, inclusive (ISO 8601)","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},{"name":"to","in":"query","required":false,"description":"Latest entry time, inclusive (ISO 8601)","schema":{"description":"Latest entry time, inclusive (ISO 8601)","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountAuditLogEntriesListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/branding/{id}":{"get":{"operationId":"account.branding.get.v1","summary":"Get branding","description":"Deprecated: use account.branding.get.v2 (account_branding_get_v2), which has no logo or favicon address. This version reads the organization's widget branding (colors, font, custom CSS, widget position and greeting), or null when none is set, beside the dashboard logo; its logoUrl and faviconUrl are retired and always null. The id is the organization id.","deprecated":true,"tags":["account"],"x-cli-name":"account-branding-get","x-point11-scope":"account:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organization id","schema":{"type":"string","description":"The organization id"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountBrandingGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/branding-v2/{id}":{"get":{"operationId":"account.branding.get.v2","summary":"Get branding (v2)","description":"Read the organization's widget branding (colors, font, custom CSS, widget position and greeting), or null when none is set, beside the dashboard logo. The id is the organization id.","tags":["account"],"x-cli-name":"account-branding-get-v2","x-point11-scope":"account:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organization id","schema":{"type":"string","description":"The organization id"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountBrandingGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/branding/update":{"post":{"operationId":"account.branding.update.v1","summary":"Update branding","description":"Deprecated: use account.branding.update.v2 (account_branding_update_v2), which has no logo or favicon address. This version sets any of the organization's widget branding fields; omitted fields keep their values. logoUrl and faviconUrl are retired: null is accepted and changes nothing, any other value is refused. Returns the saved branding, with logoUrl and faviconUrl always null.","deprecated":true,"tags":["account"],"x-cli-name":"account-branding-update","x-point11-scope":"account:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountBrandingUpdateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountBrandingUpdateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/branding/update-v2":{"post":{"operationId":"account.branding.update.v2","summary":"Update branding (v2)","description":"Set any of the organization's widget branding fields (colors, font, custom CSS, widget position and greeting); omitted fields keep their values. Returns the saved branding.","tags":["account"],"x-cli-name":"account-branding-update-v2","x-point11-scope":"account:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountBrandingUpdateV2Request"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountBrandingUpdateV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/organization-logos/delete":{"post":{"operationId":"account.organization-logos.delete.v1","summary":"Delete organization logos","description":"Remove the organization's logo from the dashboard chrome. Removing when no logo is set succeeds and changes nothing. Set a new logo with account_organization_logos_update.","tags":["account"],"x-cli-name":"account-organization-logos-delete","x-point11-scope":"account:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountOrganizationLogosDeleteRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountOrganizationLogosDeleteResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/organization-logos/update":{"post":{"operationId":"account.organization-logos.update.v1","summary":"Update organization logos","description":"Set the organization's dashboard logo from a base64 JPEG, PNG, WebP, GIF, AVIF, TIFF, or SVG image of at most 2 MB. The image is re-encoded (an SVG is rasterized, and AVIF or TIFF becomes PNG with transparency or WebP without) and replaces any current logo; returns the logo as account_branding_get_v2 reads it.","tags":["account"],"x-cli-name":"account-organization-logos-update","x-point11-scope":"account:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountOrganizationLogosUpdateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountOrganizationLogosUpdateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/invitations/accept":{"post":{"operationId":"account.invitations.accept.v1","summary":"Accept invitations","description":"Join the organization a pending invitation names, by its id, when it was sent to the email on the signed-in person's own Point11 account. An organization that requires single sign-on for that address is joined by signing in through it instead. Returns the organization joined and the person's role there.","tags":["account"],"x-cli-name":"account-invitations-accept","x-point11-scope":"account:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}},{"name":"Point11-Confirm","in":"header","required":true,"description":"Explicit human confirmation of this operation's effect.","schema":{"type":"string","enum":["true"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountInvitationsAcceptRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountInvitationsAcceptResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/pending-invitations":{"get":{"operationId":"account.pending-invitations.list.v1","summary":"List pending invitations","description":"List the pending, unexpired invitations sent to the email on the signed-in person's own Point11 account, into any open organization, each with its organization, role, inviter, expiry, and whether the organization requires single sign-on for that address.","tags":["account"],"x-cli-name":"account-pending-invitations-list","x-point11-scope":"account:read","security":[{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"ids","in":"query","required":false,"description":"Only these invitation ids","schema":{"description":"Only these invitation ids","minItems":1,"maxItems":50,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountPendingInvitationsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/sessions":{"get":{"operationId":"account.sessions.list.v1","summary":"List sessions","description":"List the signed-in person's own active sign-in sessions: browser and operating system, IP address, sign-in method, when each started and expires, and which one is this device.","tags":["account"],"x-cli-name":"account-sessions-list","x-point11-scope":"account:read","security":[{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountSessionsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/sessions-v2":{"get":{"operationId":"account.sessions.list.v2","summary":"List sessions (v2)","description":"List the signed-in person's own active sign-in sessions: browser and operating system, IP address, sign-in method (an emailed code, a passkey, Google, Microsoft or single sign-on), when each started and expires, and which one is this device.","tags":["account"],"x-cli-name":"account-sessions-list-v2","x-point11-scope":"account:read","security":[{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountSessionsListV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/mfa-factors":{"get":{"operationId":"account.mfa-factors.list.v1","summary":"List mfa factors","description":"Deprecated: use account.mfa-factors.list.v2 (account_mfa_factors_list_v2), which lists every kind of method. This version lists the signed-in person's authenticator apps only, each by its WorkOS factor id with when it was added, and leaves out passkeys and text-message numbers.","deprecated":true,"tags":["account"],"x-cli-name":"account-mfa-factors-list","x-point11-scope":"account:read","security":[{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountMfaFactorsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/mfa-factors-v2":{"get":{"operationId":"account.mfa-factors.list.v2","summary":"List mfa factors (v2)","description":"List the signed-in person's own two-step verification methods (passkeys, authenticator apps and text-message numbers), each with its name, kind, whether it is the default, when it was added and last used, and how many recovery codes are unused.","tags":["account"],"x-cli-name":"account-mfa-factors-list-v2","x-point11-scope":"account:read","security":[{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountMfaFactorsListV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/trusted-browsers":{"get":{"operationId":"account.trusted-browsers.list.v1","summary":"List trusted browsers","description":"List the browsers the signed-in person trusted to skip two-step verification's second step: each browser, when it was trusted, when its trust ends and when it was last used.","tags":["account"],"x-cli-name":"account-trusted-browsers-list","x-point11-scope":"account:read","security":[{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountTrustedBrowsersListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/two-step-policy/{id}":{"get":{"operationId":"account.two-step-policy.get.v1","summary":"Get two step policy","description":"Read whether the organization requires two-step verification, until when a member without it is still let in, which methods count, and how many days a trusted browser may skip the second step.","tags":["account"],"x-cli-name":"account-two-step-policy-get","x-point11-scope":"account:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organization id","schema":{"type":"string","description":"The organization id"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountTwoStepPolicyGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/two-step-members":{"get":{"operationId":"account.two-step-members.list.v1","summary":"List two step members","description":"List the organization's members with whether each has two-step verification on, for owners and admins.","tags":["account"],"x-cli-name":"account-two-step-members-list","x-point11-scope":"account:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountTwoStepMembersListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/two-step-members-v2":{"get":{"operationId":"account.two-step-members.list.v2","summary":"List two step members (v2)","description":"List the organization's members with their two-step verification posture, for owners and admins: whether each has it on, which kinds of method (passkey, passkey that can't sync, authenticator app, text message), whether any is phishing-resistant, whether they sign in through the organization's single sign-on, when they last answered a second step, how many browsers they trust, and how many of the organization's API keys they minted without a second step.","tags":["account"],"x-cli-name":"account-two-step-members-list-v2","x-point11-scope":"account:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountTwoStepMembersListV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/sign-in-history":{"get":{"operationId":"account.sign-in-history.list.v1","summary":"List sign in history","description":"List the signed-in person's own recent sign-ins: when, how (email code, Google or single sign-on), IP address and device.","tags":["account"],"x-cli-name":"account-sign-in-history-list","x-point11-scope":"account:read","security":[{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountSignInHistoryListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/sign-in-history-v2":{"get":{"operationId":"account.sign-in-history.list.v2","summary":"List sign in history (v2)","description":"List the signed-in person's own recent sign-ins: when, how (an emailed code, a passkey, Google, Microsoft or single sign-on), IP address and device.","tags":["account"],"x-cli-name":"account-sign-in-history-list-v2","x-point11-scope":"account:read","security":[{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountSignInHistoryListV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/member-sign-ins":{"get":{"operationId":"account.member-sign-ins.list.v1","summary":"List member sign ins","description":"List the sign-ins of the organization's current members since each joined: who, when, how, IP address and device.","tags":["account"],"x-cli-name":"account-member-sign-ins-list","x-point11-scope":"account:read","security":[{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountMemberSignInsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/member-sign-ins-v2":{"get":{"operationId":"account.member-sign-ins.list.v2","summary":"List member sign ins (v2)","description":"List the sign-ins of the organization's current members since each joined: who, when, how (an emailed code, a passkey, Google, Microsoft or single sign-on), IP address and device.","tags":["account"],"x-cli-name":"account-member-sign-ins-list-v2","x-point11-scope":"account:read","security":[{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountMemberSignInsListV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/support-access-settings/{id}":{"get":{"operationId":"account.support-access-settings.get.v1","summary":"Get support access settings","description":"Deprecated: use account.support-access-settings.get.v2 (account_support_access_settings_get_v2), which names every mode. This version reads the mode as `notify` or `approval`, an organization on `allowed` reading as `notify` (support may view without a window), and the support access window that is open now, if any. The id is the organization id.","deprecated":true,"tags":["account"],"x-cli-name":"account-support-access-settings-get","x-point11-scope":"account:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organization id","schema":{"type":"string","description":"The organization id"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountSupportAccessSettingsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/support-access-settings-v2/{id}":{"get":{"operationId":"account.support-access-settings.get.v2","summary":"Get support access settings (v2)","description":"Read when Point11 support may view the app as one of your members: the mode (`allowed`, `notify` or `approval`) and the support access window that is open now, if any. The id is the organization id.","tags":["account"],"x-cli-name":"account-support-access-settings-get-v2","x-point11-scope":"account:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organization id","schema":{"type":"string","description":"The organization id"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountSupportAccessSettingsGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/sso-domains":{"get":{"operationId":"account.sso-domains.list.v1","summary":"List sso domains","description":"List the organization's email domains for single sign-on, each verified, pending or failed, with the DNS TXT record that proves one not yet verified. Only the owner can do this.","tags":["account"],"x-cli-name":"account-sso-domains-list","x-point11-scope":"account:read","security":[{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountSsoDomainsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/sso-settings/{id}":{"get":{"operationId":"account.sso-settings.get.v1","summary":"Get sso settings","description":"Read the organization's single sign-on state: whether its identity provider connection is set up and active, its verified email domains, and whether single sign-on is required for them. The id is the organization id.","tags":["account"],"x-cli-name":"account-sso-settings-get","x-point11-scope":"account:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organization id","schema":{"type":"string","description":"The organization id"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountSsoSettingsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/connected-apps":{"get":{"operationId":"account.connected-apps.list.v1","summary":"List connected apps","description":"List the AI clients and other apps that have acted for the signed-in member over OAuth in the current organization: each one's client id, display name, level (read_only, full or blocked) and when it first and last acted. The organization's policy (account_ai_client_policies_get) caps every level.","tags":["account"],"x-cli-name":"account-connected-apps-list","x-point11-scope":"account:read","security":[{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountConnectedAppsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/account/ai-client-policies/{id}":{"get":{"operationId":"account.ai-client-policies.get.v1","summary":"Get ai client policies","description":"Read what third-party AI clients and apps acting for the organization's members over OAuth may do: allowed (as each member's role and own level allow), read_only (read only) or off (every call refused). API keys are not affected. The id is the organization id.","tags":["account"],"x-cli-name":"account-ai-client-policies-get","x-point11-scope":"account:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The organization id","schema":{"type":"string","description":"The organization id"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountAiClientPoliciesGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/campaigns/activities-v3/{id}":{"get":{"operationId":"campaigns.activities.get.v3","summary":"Get activities (v3)","description":"Read what is next and what runs now for the organization's campaigns: id \"organization\", a product (\"discovery\", \"experience\", \"research\") or one campaign id (one the Campaigns list holds; any other is not found). Returns the next customer and run; the customer work in flight (for a campaign, from its product's calendar: running, admitted and due, or placed and due, a launch whose first customer is ahead not in flight; for a product or the organization, from stored facts: every unfinished run Billing admitted for an entry as running, and each campaign's stored next customer once due); the part of it that campaigns a person paused or archived hold (`finishing`: earlier work finishing, none of it new); why nothing is scheduled when paused or on hold; Billing's admission of new work per product in scope; and the activity revision. A campaign Point11 holds (an operator stopped a run and has not released it) promises no next customer or run, and when nothing else in scope is active the pause names it (cause \"hold\").","tags":["campaigns"],"x-cli-name":"campaigns-activities-get-v3","x-point11-scope":"campaigns:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The scope: \"organization\", a product (\"discovery\", \"experience\", \"research\"), or one campaign id.","schema":{"anyOf":[{"type":"string","enum":["organization","discovery","research","experience"]},{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"}],"description":"The scope: \"organization\", a product (\"discovery\", \"experience\", \"research\"), or one campaign id."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignsActivitiesGetV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/campaigns/activity-revisions/{id}":{"get":{"operationId":"campaigns.activity-revisions.get.v1","summary":"Get activity revisions","description":"Read the organization's campaign activity revision (id \"organization\"): an opaque value that changes whenever campaign work changes (an entry opens or settles, or its results publish), a run is admitted or settles, a CRM import moves through a phase, a Google Ads sync settles, or the account's admission of new work changes, and never while a run only progresses. Compare it between calls to decide whether to read activity again. Also returns the campaign work revision (`work`), which changes only with campaign work, never with a run's admission alone: compare it to decide whether to read campaign results again.","tags":["campaigns"],"x-cli-name":"campaigns-activity-revisions-get","x-point11-scope":"campaigns:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Always \"organization\".","schema":{"type":"string","const":"organization","description":"Always \"organization\"."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignsActivityRevisionsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/campaigns/portfolios/{id}":{"get":{"operationId":"campaigns.portfolios.get.v1","summary":"Get portfolios","description":"Read the organization's campaign portfolio (id \"organization\"): which products it has run, every listed campaign by name, the current campaign (the preferred one while it is listed, else the newest listed), and the campaign that opens as current (the preferred one while it has results to show, else the newest that does).","tags":["campaigns"],"x-cli-name":"campaigns-portfolios-get","x-point11-scope":"campaigns:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Always \"organization\".","schema":{"type":"string","const":"organization","description":"Always \"organization\"."}},{"name":"preferredCampaignId","in":"query","required":false,"description":"The campaign the caller has selected; current and openable name it while they may.","schema":{"description":"The campaign the caller has selected; current and openable name it while they may.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignsPortfoliosGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/campaigns/summaries-v2":{"get":{"operationId":"campaigns.summaries.list.v2","summary":"List summaries (v2)","description":"List the organization's campaigns across Discovery, Experience and Research, optionally one product and one lifecycle status, sorted by a column. Each row carries its schedule, its work counted by its entries (each launch, scheduled firing or run now: a Discovery dispatch, an Experience cycle, a Research run), its customer work in flight from its product's calendar, setup readiness, and whether the account admits its new work; an Experience Mirror's customers are its source Discovery campaign's. Returns totalCount and whether the organization has any campaign at all.","tags":["campaigns"],"x-cli-name":"campaigns-summaries-list-v2","x-point11-scope":"campaigns:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"product","in":"query","required":false,"description":"Only this product's campaigns; omit for every product.","schema":{"description":"Only this product's campaigns; omit for every product.","type":"string","enum":["discovery","research","experience"]}},{"name":"view","in":"query","required":false,"description":"Only campaigns in this lifecycle status; \"all\" (the default) is every one.","schema":{"description":"Only campaigns in this lifecycle status; \"all\" (the default) is every one.","type":"string","enum":["all","active","paused","archived"]}},{"name":"sort","in":"query","required":false,"description":"The column to sort by. Every product sorts by name, type and updatedAt; one product also by brandUrl; Experience also by scheduleType, frequency and sourceCampaign. Any other sorts by updatedAt, newest first.","schema":{"description":"The column to sort by. Every product sorts by name, type and updatedAt; one product also by brandUrl; Experience also by scheduleType, frequency and sourceCampaign. Any other sorts by updatedAt, newest first.","type":"string","enum":["name","brandUrl","type","updatedAt","scheduleType","frequency","sourceCampaign"]}},{"name":"descending","in":"query","required":false,"description":"Sort descending; ignored without sort.","schema":{"description":"Sort descending; ignored without sort.","type":"boolean"}},{"name":"brandIcons","in":"query","required":false,"description":"false reads no brand favicons, for a caller that draws none: every row's brandIcon is then null. Omit it, or pass true, to read each row's.","schema":{"description":"false reads no brand favicons, for a caller that draws none: every row's brandIcon is then null. Omit it, or pass true, to read each row's.","type":"boolean"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignsSummariesListV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/campaigns/summaries-v2/{id}":{"get":{"operationId":"campaigns.summaries.get.v2","summary":"Get summaries (v2)","description":"Get one Discovery, Experience or Research campaign as campaigns_summaries_list_v2 lists it, by its id or route key (`campaignKey`), even while it is archived or still being set up; a campaign that list does not hold is not found. Also says whether Point11 support already owns its failed work. Read its saved setup with its product's campaign-settings read (for example discovery_campaign_settings_get).","tags":["campaigns"],"x-cli-name":"campaigns-summaries-get-v2","x-point11-scope":"campaigns:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The campaign's id, or its route key (`campaignKey`).","schema":{"type":"string","minLength":1,"maxLength":120,"description":"The campaign's id, or its route key (`campaignKey`)."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignsSummariesGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/campaigns/campaign-routes/{id}":{"get":{"operationId":"campaigns.campaign-routes.get.v1","summary":"Get campaign routes","description":"Get the Discovery, Experience or Research campaign a route key names (its `campaignKey`, or its id), narrowly: its id, route key, product, name and lifecycle status, even while it is archived or still being set up. Pass settings: true to also get what its settings page decides by: its website, schedule, work counted by its entries, and setup readiness, as campaigns_summaries_get_v2 states them. A key naming no campaign the organization's Campaigns list holds is not found. Read its saved setup with its product's campaign-settings read, and its full list row with campaigns_summaries_get_v2.","tags":["campaigns"],"x-cli-name":"campaigns-campaign-routes-get","x-point11-scope":"campaigns:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The campaign's id, or its route key (`campaignKey`).","schema":{"type":"string","minLength":1,"maxLength":120,"description":"The campaign's id, or its route key (`campaignKey`)."}},{"name":"settings","in":"query","required":false,"description":"true also answers the campaign's website, schedule, work and setup readiness (`settings`); omit it for the campaign alone.","schema":{"description":"true also answers the campaign's website, schedule, work and setup readiness (`settings`); omit it for the campaign alone.","type":"boolean"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignsCampaignRoutesGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/campaigns/campaign-selections":{"get":{"operationId":"campaigns.campaign-selections.list.v1","summary":"List campaign selections","description":"List every campaign campaigns_summaries_list_v2 holds under the same product and lifecycle-status filters, narrowly, to select them all across its pages: each campaign's id, product, lifecycle status, schedule mode (with a one-time campaign's next run) and work state, the facts a lifecycle command's eligibility reads, by name, up to 1,000 a page. Returns totalCount; pass the returned nextCursor to continue. A cursor whose campaign has left the list is refused, and the caller starts again. Read a campaign's full row with campaigns_summaries_get_v2.","tags":["campaigns"],"x-cli-name":"campaigns-campaign-selections-list","x-point11-scope":"campaigns:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"product","in":"query","required":false,"description":"Only this product's campaigns; omit for every product.","schema":{"description":"Only this product's campaigns; omit for every product.","type":"string","enum":["discovery","research","experience"]}},{"name":"view","in":"query","required":false,"description":"Only campaigns in this lifecycle status; \"all\" (the default) is every one.","schema":{"description":"Only campaigns in this lifecycle status; \"all\" (the default) is every one.","type":"string","enum":["all","active","paused","archived"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignsCampaignSelectionsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/campaigns/campaign-entries":{"get":{"operationId":"campaigns.campaign-entries.list.v1","summary":"List campaign entries","description":"Deprecated: use campaigns.campaign-entries.list.v2 (campaigns_campaign_entries_list_v2) to read an edit's rerun as `edit_rerun`; this version reads one as `run_now`. List one Discovery, Experience or Research campaign's entries (each launch, scheduled run, run now, or recovery), newest first. Each carries what started it and who asked, its status, and its units' progress: the visits, interviews or conversations admitted, delivered, failed and still open, the outcome they add up to, and failure reasons with their counts. An entry Point11 ran itself (an operator's test run) is not listed, except the settled results of a Discovery campaign Point11 ran and published to the organization; a campaign the Campaigns list does not hold is not found. Pass the returned nextCursor to continue.","deprecated":true,"tags":["campaigns"],"x-cli-name":"campaigns-campaign-entries-list","x-point11-scope":"campaigns:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"campaignId","in":"query","required":true,"description":"The campaign whose entries to list.","schema":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The campaign whose entries to list."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignsCampaignEntriesListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/campaigns/campaign-entries/{id}":{"get":{"operationId":"campaigns.campaign-entries.get.v1","summary":"Get campaign entries","description":"Deprecated: use campaigns.campaign-entries.get.v2 (campaigns_campaign_entries_get_v2) to read an edit's rerun as `edit_rerun`; this version reads one as `run_now`. Get one campaign entry by id, as campaigns.campaign-entries.list.v1 lists it, with a page of its units (visits, interviews or conversations), each with its state and failure reason; page the units with limit and units.nextCursor. An entry the list does not show is not found. A launch or run now answers the entryId it started.","deprecated":true,"tags":["campaigns"],"x-cli-name":"campaigns-campaign-entries-get","x-point11-scope":"campaigns:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The entry's id.","schema":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The entry's id."}},{"name":"limit","in":"query","required":false,"description":"Number of the entry's units to return (1–1000)","schema":{"default":20,"description":"Number of the entry's units to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as units.nextCursor by the previous page of units","schema":{"description":"Opaque cursor returned as units.nextCursor by the previous page of units","type":"string","minLength":1,"maxLength":1024}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignsCampaignEntriesGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/campaigns/campaign-entries-v2":{"get":{"operationId":"campaigns.campaign-entries.list.v2","summary":"List campaign entries (v2)","description":"List one Discovery, Experience or Research campaign's entries (each launch, scheduled run, run now, recovery, or edit rerun: customers a person's edit gave a new version, rerun once on it as their run of the campaign's current period), newest first. Each carries what started it and who asked, its status, and its units' progress: the visits, interviews or conversations admitted, delivered, failed and still open, the outcome they add up to, and failure reasons with their counts. An entry Point11 ran itself (an operator's test run) is not listed, except the settled results of a Discovery campaign Point11 ran and published to the organization; a campaign the Campaigns list does not hold is not found. Pass the returned nextCursor to continue.","tags":["campaigns"],"x-cli-name":"campaigns-campaign-entries-list-v2","x-point11-scope":"campaigns:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"campaignId","in":"query","required":true,"description":"The campaign whose entries to list.","schema":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The campaign whose entries to list."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignsCampaignEntriesListV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/campaigns/campaign-entries-v2/{id}":{"get":{"operationId":"campaigns.campaign-entries.get.v2","summary":"Get campaign entries (v2)","description":"Get one campaign entry by id, as campaigns_campaign_entries_list_v2 lists it, with a page of its units (visits, interviews or conversations), each with its state and failure reason; page the units with limit and units.nextCursor. An entry the list does not show is not found. A launch or run now answers the entryId it started.","tags":["campaigns"],"x-cli-name":"campaigns-campaign-entries-get-v2","x-point11-scope":"campaigns:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The entry's id.","schema":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The entry's id."}},{"name":"limit","in":"query","required":false,"description":"Number of the entry's units to return (1–1000)","schema":{"default":20,"description":"Number of the entry's units to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as units.nextCursor by the previous page of units","schema":{"description":"Opaque cursor returned as units.nextCursor by the previous page of units","type":"string","minLength":1,"maxLength":1024}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignsCampaignEntriesGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/campaigns/member-reruns":{"get":{"operationId":"campaigns.member-reruns.list.v1","summary":"List member reruns","description":"List the reruns one edit asked for (by requestId: the edit's rerun request) or one customer's reruns (by customerId), newest first: each customer's rerun in one campaign, waiting to start, running or finished in its campaign entry (entryId, read with campaigns_campaign_entries_get_v2), or ended without running and why (expired after 24 hours waiting, the campaign paused or archived, the customer removed or erased, or Billing's refusal code).","tags":["campaigns"],"x-cli-name":"campaigns-member-reruns-list","x-point11-scope":"campaigns:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"requestId","in":"query","required":false,"description":"The edit's rerun request.","schema":{"description":"The edit's rerun request.","type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"}},{"name":"customerId","in":"query","required":false,"description":"A customer whose reruns to list.","schema":{"description":"A customer whose reruns to list.","type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignsMemberRerunsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/campaigns/lifecycles/pause":{"post":{"operationId":"campaigns.lifecycles.pause.v1","summary":"Pause lifecycles","description":"Pause campaigns of any product so no new work starts; work already running finishes. The user must approve. Returns each campaign's outcome: changed, unchanged, blocked (with the reason), missing, or pending.","tags":["campaigns"],"x-cli-name":"campaigns-lifecycles-pause","x-point11-scope":"campaigns:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}},{"name":"Point11-Confirm","in":"header","required":true,"description":"Explicit human confirmation of this operation's effect.","schema":{"type":"string","enum":["true"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignsLifecyclesPauseRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignsLifecyclesPauseResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/campaigns/lifecycles/resume":{"post":{"operationId":"campaigns.lifecycles.resume.v1","summary":"Resume lifecycles","description":"Resume paused campaigns so their scheduled work starts again against the organization's allowance. The user must approve. Refused while the organization's Analytics subscription does not admit new work. Returns each campaign's outcome.","tags":["campaigns"],"x-cli-name":"campaigns-lifecycles-resume","x-point11-scope":"campaigns:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}},{"name":"Point11-Confirm","in":"header","required":true,"description":"Explicit human confirmation of this operation's effect.","schema":{"type":"string","enum":["true"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignsLifecyclesResumeRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignsLifecyclesResumeResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/campaigns/lifecycles/archive":{"post":{"operationId":"campaigns.lifecycles.archive.v1","summary":"Archive lifecycles","description":"Archive paused campaigns: they start no work and keep their results until restored. An active campaign is blocked until it is paused. The user must approve. Returns each campaign's outcome.","tags":["campaigns"],"x-cli-name":"campaigns-lifecycles-archive","x-point11-scope":"campaigns:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}},{"name":"Point11-Confirm","in":"header","required":true,"description":"Explicit human confirmation of this operation's effect.","schema":{"type":"string","enum":["true"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignsLifecyclesArchiveRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignsLifecyclesArchiveResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/campaigns/lifecycles/restore":{"post":{"operationId":"campaigns.lifecycles.restore.v1","summary":"Restore lifecycles","description":"Restore archived campaigns to paused; resume them to start work again. The user must approve. Returns each campaign's outcome.","tags":["campaigns"],"x-cli-name":"campaigns-lifecycles-restore","x-point11-scope":"campaigns:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}},{"name":"Point11-Confirm","in":"header","required":true,"description":"Explicit human confirmation of this operation's effect.","schema":{"type":"string","enum":["true"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignsLifecyclesRestoreRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignsLifecyclesRestoreResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/campaigns/lifecycles/delete":{"post":{"operationId":"campaigns.lifecycles.delete.v1","summary":"Delete lifecycles","description":"Delete campaigns: stop their work and remove them from the organization's campaigns. A deleted campaign cannot be changed again. A campaign whose running work is still stopping reports pending and finishes deleting without another call. The user must approve. Returns each campaign's outcome.","tags":["campaigns"],"x-cli-name":"campaigns-lifecycles-delete","x-point11-scope":"campaigns:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}},{"name":"Point11-Confirm","in":"header","required":true,"description":"Explicit human confirmation of this operation's effect.","schema":{"type":"string","enum":["true"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignsLifecyclesDeleteRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignsLifecyclesDeleteResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/campaigns/calendars/{id}":{"get":{"operationId":"campaigns.calendars.get.v1","summary":"Get calendars","description":"Read the organization's commercial calendar (id \"organization\") at one zoom level (day, week, month or agenda around `anchor`, bucketed in `timeZone`): its active and paused campaigns of every product, or of `products` and `profiles` alone (it draws them 50 to a page, by product then name with the campaigns holding `customerId` first: `cursor` reads another page, `campaignPage` says where this one stands, `truncated` says other pages exist, and `campaignId`, else the entry's campaign, opens on the page that lists it; it also lists the ones switched off in `hiddenCampaignIds` beside every page), each drawn campaign's UTC months with exact hourly counts and a few named customer interactions, the campaigns whose read failed, every interaction of `customerId` when given (at most 500 per campaign, nearest `anchor`; `customerEntriesTruncated` says more exist), and the entry to open on (`entryCampaignId` with `entryId`). The organization's own id is also accepted as `id`.","tags":["campaigns"],"x-cli-name":"campaigns-calendars-get","x-point11-scope":"campaigns:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Always \"organization\"; the organization's own id is also accepted.","schema":{"type":"string","minLength":1,"description":"Always \"organization\"; the organization's own id is also accepted."}},{"name":"view","in":"query","required":true,"schema":{"type":"string","enum":["day","week","month","agenda"]}},{"name":"anchor","in":"query","required":true,"description":"The day the grid is drawn around, on `timeZone`'s clock.","schema":{"type":"string","description":"The day the grid is drawn around, on `timeZone`'s clock."}},{"name":"timeZone","in":"query","required":true,"description":"The zone days and hours are bucketed in.","schema":{"type":"string","description":"The zone days and hours are bucketed in."}},{"name":"defaultTimeZone","in":"query","required":false,"description":"The zone a viewer's choice replaces; `timeZone` when absent.","schema":{"description":"The zone a viewer's choice replaces; `timeZone` when absent.","type":"string"}},{"name":"products","in":"query","required":false,"description":"Keep only these products' campaigns; none keeps every product.","schema":{"description":"Keep only these products' campaigns; none keeps every product.","maxItems":3,"type":"array","items":{"type":"string","enum":["discovery","research","experience"]}}},{"name":"profiles","in":"query","required":false,"description":"Keep only these business profiles' campaigns; none keeps every profile.","schema":{"description":"Keep only these business profiles' campaigns; none keeps every profile.","maxItems":24,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},{"name":"hiddenCampaignIds","in":"query","required":false,"description":"Campaigns listed but switched off: never read, listed beside every page, and not counted in its 50.","schema":{"description":"Campaigns listed but switched off: never read, listed beside every page, and not counted in its 50.","maxItems":50,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},{"name":"cursor","in":"query","required":false,"description":"The page of campaigns after the one this cursor names (`campaignPage.nextCursor` or `previousCursor`); none reads the first 50.","schema":{"description":"The page of campaigns after the one this cursor names (`campaignPage.nextCursor` or `previousCursor`); none reads the first 50.","type":"string","minLength":1,"maxLength":256}},{"name":"campaignId","in":"query","required":false,"description":"Open on the page of campaigns that lists this one, unless `cursor`'s page already does: a campaign a search picked.","schema":{"description":"Open on the page of campaigns that lists this one, unless `cursor`'s page already does: a campaign a search picked.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"customerId","in":"query","required":false,"description":"Read every interaction of this customer; the campaigns holding them lead the pages.","schema":{"description":"Read every interaction of this customer; the campaigns holding them lead the pages.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"only","in":"query","required":false,"description":"With `customerId`: draw only that customer, so months name nobody.","schema":{"description":"With `customerId`: draw only that customer, so months name nobody.","type":"boolean"}},{"name":"entryCampaignId","in":"query","required":false,"description":"With `entryId`: the campaign of the entry the calendar opens on, which opens on the page that lists it as `campaignId` does, unless `campaignId` names another.","schema":{"description":"With `entryId`: the campaign of the entry the calendar opens on, which opens on the page that lists it as `campaignId` does, unless `campaignId` names another.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"entryId","in":"query","required":false,"description":"With `entryCampaignId`: the entry the calendar opens on, read whatever `showPaused` says.","schema":{"description":"With `entryCampaignId`: the entry the calendar opens on, read whatever `showPaused` says.","type":"string","minLength":1,"maxLength":128}},{"name":"showPaused","in":"query","required":false,"description":"False leaves out paused activity: the work a paused campaign holds and will not start while it stays paused (a waiting interaction, or a Research interview its run has committed), from every count and name. Finished, failed, missed and started work always stays, and so does the work of an Active campaign whose subscription is paused. True when absent.","schema":{"description":"False leaves out paused activity: the work a paused campaign holds and will not start while it stays paused (a waiting interaction, or a Research interview its run has committed), from every count and name. Finished, failed, missed and started work always stays, and so does the work of an Active campaign whose subscription is paused. True when absent.","type":"boolean"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignsCalendarsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/campaigns/calendars/search":{"get":{"operationId":"campaigns.calendars.search.v1","summary":"Search calendars","description":"Search the organization calendar by customer name, campaign name or a date phrase over the months around the grid being viewed. Returns the date the phrase names, matching campaigns (at most 50), matching customers with their interaction counts, and those interactions in time order, the ones nearest `anchor`: at most 20 per matching customer in each campaign that holds one, or per campaign found by name, and 100 in all; `truncated` says more campaigns, customers or interactions matched than are returned, so more words narrow it; `failed` counts campaigns whose read failed. A query shorter than two characters reads only as a date. `view` \"year\" is a deprecated alias read as \"month\", so it searches a month's horizon.","tags":["campaigns"],"x-cli-name":"campaigns-calendars-search","x-point11-scope":"campaigns:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"view","in":"query","required":true,"description":"\"year\" is a deprecated alias read as \"month\", so it searches a month's horizon.","schema":{"description":"\"year\" is a deprecated alias read as \"month\", so it searches a month's horizon.","type":"string","enum":["day","week","month","agenda","year"]}},{"name":"anchor","in":"query","required":true,"schema":{"type":"string"}},{"name":"zone","in":"query","required":true,"schema":{"type":"string"}},{"name":"query","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":80}},{"name":"wide","in":"query","required":false,"description":"Search six months each side of the grid, not one.","schema":{"description":"Search six months each side of the grid, not one.","type":"boolean"}},{"name":"products","in":"query","required":false,"description":"Keep only these products' campaigns; none keeps every product.","schema":{"description":"Keep only these products' campaigns; none keeps every product.","maxItems":3,"type":"array","items":{"type":"string","enum":["discovery","research","experience"]}}},{"name":"profiles","in":"query","required":false,"description":"Keep only these business profiles' campaigns; none keeps every profile.","schema":{"description":"Keep only these business profiles' campaigns; none keeps every profile.","maxItems":24,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignsCalendarsSearchResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/campaigns/calendar-filter-options/{id}":{"get":{"operationId":"campaigns.calendar-filter-options.get.v1","summary":"Get calendar filter options","description":"List what the organization calendar (id \"organization\") can be filtered by: the products and business profiles that have an active or paused campaign on it, however many there are, and the first 50 of those campaigns.","tags":["campaigns"],"x-cli-name":"campaigns-calendar-filter-options-get","x-point11-scope":"campaigns:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Always \"organization\".","schema":{"type":"string","const":"organization","description":"Always \"organization\"."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignsCalendarFilterOptionsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/campaigns/calendar-windows/search":{"get":{"operationId":"campaigns.calendar-windows.search.v1","summary":"Search calendar windows","description":"Read the scheduled customer interactions of up to 50 campaigns between two instants at most 48 hours apart, in one request: each campaign's lifecycle counts and at most 500 named interactions (`entryCount` says how many there are), in the calendar's order. Only the organization's active and paused campaigns are read, whichever ids are named; `failed` counts campaigns whose read failed, and the request fails when every read did.","tags":["campaigns"],"x-cli-name":"campaigns-calendar-windows-search","x-point11-scope":"campaigns:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"campaignIds","in":"query","required":true,"description":"The campaigns the calendar shows; each is read through its own product.","schema":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":"The campaigns the calendar shows; each is read through its own product."}},{"name":"from","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},{"name":"showPaused","in":"query","required":false,"description":"False leaves out paused activity: the work a paused campaign holds and will not start while it stays paused (a waiting interaction, or a Research interview its run has committed), from every count and name. Finished, failed, missed and started work always stays, and so does the work of an Active campaign whose subscription is paused. True when absent.","schema":{"description":"False leaves out paused activity: the work a paused campaign holds and will not start while it stays paused (a waiting interaction, or a Research interview its run has committed), from every count and name. Finished, failed, missed and started work always stays, and so does the work of an Active campaign whose subscription is paused. True when absent.","type":"boolean"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignsCalendarWindowsSearchResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/campaigns/calendar-occurrences/{id}":{"get":{"operationId":"campaigns.calendar-occurrences.get.v1","summary":"Get calendar occurrences","description":"Get one scheduled customer interaction: its schedule, revision, execution facts and whether it may be moved, cancelled or restored. Pass `revision` as `expectedRevision` when changing it. `id` is the occurrence id; `campaignId` and `campaignType` name its campaign. An occurrence of a campaign the Campaigns list does not hold is not found.","tags":["campaigns"],"x-cli-name":"campaigns-calendar-occurrences-get","x-point11-scope":"campaigns:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The occurrence id.","schema":{"type":"string","minLength":1,"maxLength":128,"description":"The occurrence id."}},{"name":"campaignId","in":"query","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"campaignType","in":"query","required":true,"schema":{"type":"string","enum":["discovery","research","experience"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignsCalendarOccurrencesGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/campaigns/calendar-customers/{id}":{"get":{"operationId":"campaigns.calendar-customers.get.v1","summary":"Get calendar customers","description":"Get the customer a calendar interaction names: their name, employer, location and what sent them shopping (`profile`). A customer Business no longer holds is not found. `id` is the customer id.","tags":["campaigns"],"x-cli-name":"campaigns-calendar-customers-get","x-point11-scope":"campaigns:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The customer id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The customer id."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignsCalendarCustomersGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/campaigns/calendar-candidates/search":{"get":{"operationId":"campaigns.calendar-candidates.search.v1","summary":"Search calendar candidates","description":"Deprecated: use discovery.roster-candidates.list.v4 (discovery_roster_candidates_list_v4) with `listing` \"all\", which the calendar's customer picker reads: it pages, narrows by audience, names why each customer cannot join, and lists those already on the campaign, whom a calendar create schedules too. Search by name the customers a campaign could still admit and schedule from the calendar; empty for a product that schedules nothing by hand. Each search is charged to the caller's calendar search burst budget, shared with campaigns_calendars_search (429 RATE_LIMITED past it). A campaign that is unknown, another organization's, not in its Campaigns list, or not on the calendar (only active and paused campaigns are) is 404 RESOURCE_NOT_FOUND with `details.resource` \"campaign\" for every product, where a product that schedules nothing by hand once answered an empty list.","deprecated":true,"tags":["campaigns"],"x-cli-name":"campaigns-calendar-candidates-search","x-point11-scope":"campaigns:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"campaignType","in":"query","required":true,"schema":{"type":"string","enum":["discovery","research","experience"]}},{"name":"campaignId","in":"query","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"query","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":80}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignsCalendarCandidatesSearchResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/campaigns/calendar-commands/create":{"post":{"operationId":"campaigns.calendar-commands.create.v1","summary":"Create calendar commands","description":"Change one customer's scheduled interaction on a campaign calendar: move it, cancel it, undo an earlier change (naming that receipt's `commandId`), or schedule a new one. It changes a live schedule, so the user must approve. The Idempotency-Key is the command id: a retry with the same key and body replays the receipt, and the id spent on another change or caller is 409 IDEMPOTENCY_CONFLICT with `details.reason` `idempotency_key_reused` (use a new key). A refusal of the change is 409 CONFLICT with `details.reason`: `conflict`, the revision moved (read again, or take `details.current`, and retry; the only one that may then succeed); `locked`, the interaction's state, a paused subscription, or an undo that no longer applies (the interaction changed since that change, or the change was another caller's) refuses it; `occupied`, the customer's month already holds an interaction, live or cancelled. An interaction or campaign that is gone, or a campaign the Campaigns list does not hold, is 404 RESOURCE_NOT_FOUND. Returns the receipt with the schedule before and after.","tags":["campaigns"],"x-cli-name":"campaigns-calendar-commands-create","x-point11-scope":"campaigns:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}},{"name":"Point11-Confirm","in":"header","required":true,"description":"Explicit human confirmation of this operation's effect.","schema":{"type":"string","enum":["true"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignsCalendarCommandsCreateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignsCalendarCommandsCreateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/campaigns/customer-version-policies/update":{"post":{"operationId":"campaigns.customer-version-policies.update.v1","summary":"Update customer version policies","description":"Deprecated: no successor. Every campaign's new work now uses each customer's newest version (a customer's next conversation, interview or cycle; work already running keeps its version), so there is no policy left to choose and this changes nothing. `latest` answers changed: false with policy latest. `pinned` is no longer a choice: 409 PRECONDITION_FAILED with details.reason product_unsupported. A campaign that does not exist or is being deleted is 404 RESOURCE_NOT_FOUND.","deprecated":true,"tags":["campaigns"],"x-cli-name":"campaigns-customer-version-policies-update","x-point11-scope":"campaigns:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignsCustomerVersionPoliciesUpdateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignsCustomerVersionPoliciesUpdateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/campaigns/precision-quotes/{id}":{"get":{"operationId":"campaigns.precision-quotes.get.v1","summary":"Get precision quotes","description":"Price an order that raises one reading of a campaign (`id`) to Standard precision (±5 points): pass the reading's group (`cohort`: the whole campaign, its attribute buckets, or an outcome) and its customers. A campaign that takes no order is refused (409, its product's reason and next step in details.control); otherwise returns its product's verdict (control), the customers one order adds (eligible existing customers inside the group first, the rest generated at no charge, within the campaign's limits), the margin they reach, and every charge their interactions bring, monthly or once; place it with campaigns_precision_orders_start.","tags":["campaigns"],"x-cli-name":"campaigns-precision-quotes-get","x-point11-scope":"campaigns:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The campaign id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The campaign id."}},{"name":"cohort","in":"query","required":true,"description":"What the reading counts: the whole campaign, attribute buckets, or an outcome.","schema":{"type":"string","enum":["campaign","attribute","outcome"],"description":"What the reading counts: the whole campaign, attribute buckets, or an outcome."}},{"name":"buckets","in":"query","required":false,"description":"The group's buckets (an outcome's `within`), each \"<dimensionId>:<bucketId>\", one per dimension: `audience_mix:<id>`, `store:<location key>`.","schema":{"description":"The group's buckets (an outcome's `within`), each \"<dimensionId>:<bucketId>\", one per dimension: `audience_mix:<id>`, `store:<location key>`.","maxItems":18,"type":"array","items":{"type":"string","minLength":3,"maxLength":2100}}},{"name":"customers","in":"query","required":true,"description":"The reading's customers: the distinct customers behind its value in its span.","schema":{"type":"integer","minimum":0,"maximum":10000000,"description":"The reading's customers: the distinct customers behind its value in its span."}},{"name":"outcomeOf","in":"query","required":false,"description":"For an outcome: the distinct customers, in the same span, of what it sits in (the campaign, or its buckets).","schema":{"description":"For an outcome: the distinct customers, in the same span, of what it sits in (the campaign, or its buckets).","type":"integer","minimum":0,"maximum":10000000}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignsPrecisionQuotesGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/campaigns/precision-orders":{"get":{"operationId":"campaigns.precision-orders.list.v1","summary":"List precision orders","description":"List a campaign's precision orders, each group's newest one, newest first: its customers generated, added and measured (their first interview or visit completed) and its state, beside whether the campaign takes another order for this caller. Price one with campaigns_precision_quotes_get.","tags":["campaigns"],"x-cli-name":"campaigns-precision-orders-list","x-point11-scope":"campaigns:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"campaignId","in":"query","required":true,"description":"The campaign whose orders to list.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The campaign whose orders to list."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignsPrecisionOrdersListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/platform/runs/{id}":{"get":{"operationId":"platform.runs.get.v1","summary":"Get runs","description":"Deprecated: use platform.runs.get.v2 (platform_runs_get_v2), which names every product a run can be recorded under. Poll a durable operation's run by the runId the durable write returned: its status, product, and start and completion times. Answered in the products it was published with: a run under a product published since (customer-edit) is not found.","deprecated":true,"tags":["platform"],"x-cli-name":"platform-runs-get","x-point11-scope":"platform:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The runId a durable write returned","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The runId a durable write returned"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformRunsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/platform/runs-v2/{id}":{"get":{"operationId":"platform.runs.get.v2","summary":"Get runs (v2)","description":"Poll a durable operation's run by the runId the durable write returned: its status, product, and start and completion times.","tags":["platform"],"x-cli-name":"platform-runs-get-v2","x-point11-scope":"platform:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The runId a durable write returned","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The runId a durable write returned"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformRunsGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/platform/admin-reports/{id}":{"get":{"operationId":"platform.admin-reports.get.v1","summary":"Get admin reports","description":"Read the organization's report over the last 7, 30, or 90 UTC days, today so far included (pass id \"organization\" and a range): distinct active members, customer twins in a delivered customer-paid campaign interaction, and recommendations first acted on, each with a seven-day trailing trend; delivered work per run identity and completion day, each row named by the unit it delivered, with the six days before the window its first trend days reach; and today's members, how many were active in the window, and pending invitations.","tags":["platform"],"x-cli-name":"platform-admin-reports-get","x-point11-scope":"platform:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Always \"organization\": the caller's own.","schema":{"type":"string","const":"organization","description":"Always \"organization\": the caller's own."}},{"name":"range","in":"query","required":true,"description":"The window: the last 7, 30, or 90 UTC days, today so far included.","schema":{"type":"string","enum":["7d","30d","90d"],"description":"The window: the last 7, 30, or 90 UTC days, today so far included."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformAdminReportsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/support/messages/send":{"post":{"operationId":"support.messages.send.v1","summary":"Send messages","description":"Email a message from the signed-in member to Point11 support (their account team), with the member's name as sender and their email as Reply-To so support answers them directly. Use when the member asks for human help from Point11. Needs a signed-in user: API keys are refused. `pending` means the message is stored and Point11 keeps retrying delivery; resend with the same Idempotency-Key to check, never with a new one.","tags":["support"],"x-cli-name":"support-messages-send","x-point11-scope":"support:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupportMessagesSendRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupportMessagesSendResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/support/help-conversations/start":{"post":{"operationId":"support.help-conversations.start.v1","summary":"Start help conversations","description":"Start, or resume, the signed-in member's Point11 Help conversation: the in-app guide that answers how-to and where-is questions about Point11, reads the member's own account status as they could, and routes them through the dashboard. Returns the chat conversation and its messages so far. A member keeps one conversation a day and moves to a new one when it can no longer go on; naming the conversation they are leaving (replacesConversationId, as when it reached its limit) starts that new one. Needs a signed-in user: API keys are refused.","tags":["support"],"x-cli-name":"support-help-conversations-start","x-point11-scope":"support:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupportHelpConversationsStartRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupportHelpConversationsStartResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/revenue-tracking-configurations/create-v2":{"post":{"operationId":"business.revenue-tracking-configurations.create.v2","summary":"Create revenue tracking configurations (v2)","description":"Save your own market assumptions (annual sales, market share, and AI influence) for one researched product of a business profile (a revenue line: lineId), at company scope or one location, replacing its researched values in Tools › Products. A product holds one set of saved assumptions (a configuration): when it already has one, this fails with ALREADY_EXISTS and you update that configuration instead. Answers the profile's ledger as business_revenue_tracking_workspaces_get_v2 reads it, without the measured win rate.","tags":["business"],"x-cli-name":"business-revenue-tracking-configurations-create-v2","x-point11-scope":"business:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRevenueTrackingConfigurationsCreateV2Request"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRevenueTrackingConfigurationsCreateV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/revenue-tracking-configurations/create":{"post":{"operationId":"business.revenue-tracking-configurations.create.v1","summary":"Create revenue tracking configurations","description":"Deprecated: use business.revenue-tracking-configurations.create.v2 (business_revenue_tracking_configurations_create_v2), whose ledger states each line's AI-influenced sales. This version saves the same assumptions and answers the ledger in its published shape: onePointWinRateValueUsd is the line's one point of win rate, AI-influenced SAM ÷ 100, whatever Discovery measured.","deprecated":true,"tags":["business"],"x-cli-name":"business-revenue-tracking-configurations-create","x-point11-scope":"business:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRevenueTrackingConfigurationsCreateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRevenueTrackingConfigurationsCreateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/revenue-tracking-configurations/update-v2":{"post":{"operationId":"business.revenue-tracking-configurations.update.v2","summary":"Update revenue tracking configurations (v2)","description":"Change a product's saved market assumptions in Tools › Products (a configuration): its annual sales, market share, and AI influence. Pass the configuration's current revision as expectedRevision; if it changed since you read it, this fails with STALE_WRITE and you re-read the ledger.","tags":["business"],"x-cli-name":"business-revenue-tracking-configurations-update-v2","x-point11-scope":"business:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRevenueTrackingConfigurationsUpdateV2Request"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRevenueTrackingConfigurationsUpdateV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/revenue-tracking-configurations/update":{"post":{"operationId":"business.revenue-tracking-configurations.update.v1","summary":"Update revenue tracking configurations","description":"Deprecated: use business.revenue-tracking-configurations.update.v2 (business_revenue_tracking_configurations_update_v2), whose ledger states each line's AI-influenced sales. This version saves the same change and answers the ledger in its published shape: onePointWinRateValueUsd is the line's one point of win rate, AI-influenced SAM ÷ 100, whatever Discovery measured.","deprecated":true,"tags":["business"],"x-cli-name":"business-revenue-tracking-configurations-update","x-point11-scope":"business:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRevenueTrackingConfigurationsUpdateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRevenueTrackingConfigurationsUpdateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/revenue-tracking-configurations/delete-v2":{"post":{"operationId":"business.revenue-tracking-configurations.delete.v2","summary":"Delete revenue tracking configurations (v2)","description":"Reset one or more products' saved market assumptions in Tools › Products (configurations) to the profile's researched values. All or nothing: if any selected configuration changed since you read it, nothing is reset and this fails with STALE_WRITE.","tags":["business"],"x-cli-name":"business-revenue-tracking-configurations-delete-v2","x-point11-scope":"business:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRevenueTrackingConfigurationsDeleteV2Request"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRevenueTrackingConfigurationsDeleteV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/revenue-tracking-configurations/delete":{"post":{"operationId":"business.revenue-tracking-configurations.delete.v1","summary":"Delete revenue tracking configurations","description":"Deprecated: use business.revenue-tracking-configurations.delete.v2 (business_revenue_tracking_configurations_delete_v2), whose ledger states each line's AI-influenced sales. This version resets the same configurations and answers the ledgers in their published shape: onePointWinRateValueUsd is the line's one point of win rate, AI-influenced SAM ÷ 100, whatever Discovery measured.","deprecated":true,"tags":["business"],"x-cli-name":"business-revenue-tracking-configurations-delete","x-point11-scope":"business:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRevenueTrackingConfigurationsDeleteRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRevenueTrackingConfigurationsDeleteResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/revenue-tracking-workspaces-v2/{id}":{"get":{"operationId":"business.revenue-tracking-workspaces.get.v2","summary":"Get revenue tracking workspaces (v2)","description":"Read a business profile's ledger of market assumptions, as Tools › Products shows it, the profile named by id or profile key, or \"default\" for the one business_profile_selections_get selects: each current product (a revenue line: lines[].lineId) with its researched or saved annual sales, market share and AI influence, and what they derive: SAM (annual sales ÷ market share), the AI-influenced market (SAM × AI influence, a year, which every dollar is a share of) and AI-influenced sales (annual sales × AI influence, the brand's own). winRate pools every Discovery campaign's measurement of the line at that scope today; winRatePoint is one point of it, the AI-influenced market ÷ 100 (basis: always ceiling); both null where Discovery measured nothing or the line lacks assumptions. Scope picks the company ledger, every location ledger or one location; omit it for all.","tags":["business"],"x-cli-name":"business-revenue-tracking-workspaces-get-v2","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"scope","in":"query","required":false,"schema":{"type":"string","enum":["company","locations","location"]}},{"name":"locationKey","in":"query","required":false,"schema":{"type":"string"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRevenueTrackingWorkspacesGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/revenue-tracking-workspaces/{id}":{"get":{"operationId":"business.revenue-tracking-workspaces.get.v1","summary":"Get revenue tracking workspaces","description":"Deprecated: use business.revenue-tracking-workspaces.get.v2 (business_revenue_tracking_workspaces_get_v2), which states each line's AI-influenced sales, measured win rate and the value of a point with its basis. This version reads the same ledger in its published shape: onePointWinRateValueUsd is the line's one point of win rate, AI-influenced SAM ÷ 100, whatever Discovery measured.","deprecated":true,"tags":["business"],"x-cli-name":"business-revenue-tracking-workspaces-get","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"scope","in":"query","required":false,"schema":{"type":"string","enum":["company","locations","location"]}},{"name":"locationKey","in":"query","required":false,"schema":{"type":"string"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRevenueTrackingWorkspacesGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/revenue-tracking-location-catalogs/{id}":{"get":{"operationId":"business.revenue-tracking-location-catalogs.get.v1","summary":"Get revenue tracking location catalogs","description":"List a business profile's locations that have their own ledger of market assumptions in Tools › Products, in display order, each with the key to pass as a location scope and its label. An empty list means the profile holds market assumptions only at company level.","tags":["business"],"x-cli-name":"business-revenue-tracking-location-catalogs-get","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRevenueTrackingLocationCatalogsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/profile-selections/{id}":{"get":{"operationId":"business.profile-selections.get.v1","summary":"Get profile selections","description":"Resolve which active business profile a tool page targets. Pass a profile id or profile key to select it, or \"default\" for the most recently generated active profile; an id or key that matches no active profile also yields that default. A hostname instead selects the active profile whose website has that host, with no default. Returns the selected profile's id, key, name, and website (null when none matches) and whether the organization has other active profiles to choose from. With includeCompanySales it also returns the selected profile's annual sales: the sum of its company-wide products' annual sales in Tools › Products, over those with complete market assumptions, and how many products that adds up.","tags":["business"],"x-cli-name":"business-profile-selections-get","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"hostname","in":"query","required":false,"schema":{"type":"string","minLength":1}},{"name":"includeCompanySales","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessProfileSelectionsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/profiles":{"get":{"operationId":"business.profiles.list.v1","summary":"List profiles","description":"List the organization's active business profiles a campaign can launch under (each with finished research), most recently researched first: each profile's id, route key, display name, website, and how many current store profiles it has, the stores a physical-location campaign interviews (0 when it has none). Pass include current for every active profile, researched or not, or include all for every profile, archived and unresearched included.","tags":["business"],"x-cli-name":"business-profiles-list","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"include","in":"query","required":false,"description":"active (the default): profiles a campaign can launch under, each with finished research; current: every active profile, researched or not; all: every profile, archived and unresearched included","schema":{"default":"active","description":"active (the default): profiles a campaign can launch under, each with finished research; current: every active profile, researched or not; all: every profile, archived and unresearched included","type":"string","enum":["active","current","all"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessProfilesListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/revenue-lines-v4":{"get":{"operationId":"business.revenue-lines.list.v4","summary":"List revenue lines (v4)","description":"List every product (a revenue line: revenueLineId) with market assumptions in Tools › Products, for the organization or one business profile, at company scope (locationKey null) and each location, valued today. Every dollar is a share of aiInfluencedMarketUsd (SAM × AI influence, a year); aiInfluencedSalesUsd is annual sales × AI influence, the brand's own. winRate pools every Discovery campaign's measurement on that exact scope; winRatePoint (aiInfluencedMarketUsd ÷ 100, basis always ceiling), influencedUsd (winRatePoint × win rate; may exceed aiInfluencedSalesUsd) and influenceableUsd (winRatePoint × 100) are null, never zero, without a measurement. counted: whether the row enters totals (company scope when the company line was measured, else each measured location, never both). At every scope, Experience pools every Experience campaign's interactions on the site in the 30 UTC days ending today: siteSuccess (passed of judged journeys), experienceScore (0 to 100, scores weighted by judged journeys), and over matched pairs (one customer's journeys on our site and a competitor's, same cycle and device) matchedPairs, ourMatchedScore, competitorScore and gapPts (ours − theirs). experiencePoint (aiInfluencedMarketUsd ÷ 100) and experienceUsd (experiencePoint × gapPts; needs no Discovery measurement) are stated once where the product lives: at company scope when the company line has economics, else at each location whose own product it is; null without a pair scored on both sides. measuredBy names the campaigns pooled. A modeled annual estimate, not booked sales.","tags":["business"],"x-cli-name":"business-revenue-lines-list-v4","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"businessProfileId","in":"query","required":false,"description":"Omit for every profile.","schema":{"description":"Omit for every profile.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRevenueLinesListV4Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/revenue-lines-v3":{"get":{"operationId":"business.revenue-lines.list.v3","summary":"List revenue lines (v3)","description":"Deprecated: use business.revenue-lines.list.v4 (business_revenue_lines_list_v4), which states each line's AI-influenced sales and the value of a point. This version lists the same lines in its published shape with list.v4's dollars: worthUsd is the line's AI-influenced market, and influencedUsd and experienceUsd are list.v4's, so influencedUsd is worthUsd × win rate ÷ 100.","deprecated":true,"tags":["business"],"x-cli-name":"business-revenue-lines-list-v3","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"businessProfileId","in":"query","required":false,"description":"Omit for every profile.","schema":{"description":"Omit for every profile.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRevenueLinesListV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/revenue-lines-v2":{"get":{"operationId":"business.revenue-lines.list.v2","summary":"List revenue lines (v2)","description":"Deprecated: use business.revenue-lines.list.v4 (business_revenue_lines_list_v4), which states no interval and no noise flag. This version lists the same lines in its published shape: worthUsd is the line's AI-influenced market and influencedUsd and experienceUsd are list.v4's dollars; each pooled rate (winRate, siteSuccess) carries marginPct, the half-width of its 95% Wilson interval in points, and gapWithinNoise is always null.","deprecated":true,"tags":["business"],"x-cli-name":"business-revenue-lines-list-v2","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"businessProfileId","in":"query","required":false,"description":"Omit for every profile.","schema":{"description":"Omit for every profile.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRevenueLinesListV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/revenue-lines":{"get":{"operationId":"business.revenue-lines.list.v1","summary":"List revenue lines","description":"Deprecated: use business.revenue-lines.list.v4 (business_revenue_lines_list_v4), which states Experience dollars, the Experience Score and the gap against competitors on each line. This version lists the same lines in its published shape: worthUsd is the line's AI-influenced market, influencedUsd is list.v4's revenue influenced, the same rates, counted and measuredBy, and lostOnSiteUsd = influencedUsd × the site failure rate (100 − siteSuccess.ratePct, in percent), null when either rate was not measured, never zero. Experience's score and its figures against competitors are left out.","deprecated":true,"tags":["business"],"x-cli-name":"business-revenue-lines-list","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"businessProfileId","in":"query","required":false,"description":"Omit for every profile.","schema":{"description":"Omit for every profile.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRevenueLinesListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/revenue-summaries-v3/{id}":{"get":{"operationId":"business.revenue-summaries.get.v3","summary":"Get revenue summaries (v3)","description":"Total the organization's products (revenue lines) on each UTC day from `from` through `to` (inclusive, at most 90 days; id \"organization\"), for the organization and each business profile, or one with businessProfileId, as business_revenue_lines_list_v4 values them: economics and revenue influenced over counted lines, Experience dollars over every line with them, each line valued apart, so lines above and below competitors offset. Economics and a point's value are today's, rates each day's (Experience's over the 30 UTC days ending it). aiInfluencedMarketUsd is what revenue influenced is a share of; aiInfluencedSalesUsd the brand's own sales on those lines (which it may exceed); influenceableUsd revenue influenced at a 100% win rate; experienceAiInfluencedSalesUsd the AI-influenced sales of the lines in experienceUsd, each where the product lives. influencedUsd is null when no counted line has it, experienceUsd when no line has it; valuedLineCount, experienceValuedLineCount and measuredLineCount (lines Discovery measured that day) count lines of lineCount. A modeled annual estimate, not booked sales.","tags":["business"],"x-cli-name":"business-revenue-summaries-get-v3","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Always \"organization\": the caller's own.","schema":{"type":"string","const":"organization","description":"Always \"organization\": the caller's own."}},{"name":"from","in":"query","required":true,"description":"First UTC day to total.","schema":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"First UTC day to total."}},{"name":"to","in":"query","required":true,"description":"Last UTC day to total (inclusive).","schema":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"Last UTC day to total (inclusive)."}},{"name":"businessProfileId","in":"query","required":false,"description":"Omit for every profile.","schema":{"description":"Omit for every profile.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRevenueSummariesGetV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/revenue-summaries-v2/{id}":{"get":{"operationId":"business.revenue-summaries.get.v2","summary":"Get revenue summaries (v2)","description":"Deprecated: use business.revenue-summaries.get.v3 (business_revenue_summaries_get_v3), which states the sales beside the dollars. This version answers the same days in its published shape with summaries.v3's dollars: worthUsd is the counted lines' AI-influenced market and experienceWorthUsd the AI-influenced market of the lines counted in experienceUsd, so influencedUsd is a share of worthUsd at the pooled win rates.","deprecated":true,"tags":["business"],"x-cli-name":"business-revenue-summaries-get-v2","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Always \"organization\": the caller's own.","schema":{"type":"string","const":"organization","description":"Always \"organization\": the caller's own."}},{"name":"from","in":"query","required":true,"description":"First UTC day to total.","schema":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"First UTC day to total."}},{"name":"to","in":"query","required":true,"description":"Last UTC day to total (inclusive).","schema":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"Last UTC day to total (inclusive)."}},{"name":"businessProfileId","in":"query","required":false,"description":"Omit for every profile.","schema":{"description":"Omit for every profile.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRevenueSummariesGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/revenue-summaries/{id}":{"get":{"operationId":"business.revenue-summaries.get.v1","summary":"Get revenue summaries","description":"Deprecated: use business.revenue-summaries.get.v3 (business_revenue_summaries_get_v3), which totals Experience dollars. This version answers the same days in its published shape: worthUsd is the counted lines' AI-influenced market, influencedUsd summaries.v3's revenue influenced, the same line counts, and lostOnSiteUsd summed over counted lines as business_revenue_lines_list_v1 values it, null when no counted line has it. Experience dollars are left out.","deprecated":true,"tags":["business"],"x-cli-name":"business-revenue-summaries-get","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Always \"organization\": the caller's own.","schema":{"type":"string","const":"organization","description":"Always \"organization\": the caller's own."}},{"name":"from","in":"query","required":true,"description":"First UTC day to total.","schema":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"First UTC day to total."}},{"name":"to","in":"query","required":true,"description":"Last UTC day to total (inclusive).","schema":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"Last UTC day to total (inclusive)."}},{"name":"businessProfileId","in":"query","required":false,"description":"Omit for every profile.","schema":{"description":"Omit for every profile.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRevenueSummariesGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/revenue-lines/create-v2":{"post":{"operationId":"business.revenue-lines.create.v2","summary":"Create revenue lines (v2)","description":"Add a product (a revenue line: the answer's revenueLine) to a business profile at once, without research: a new profile version carrying the line, with an existing line's audiences (audiencesFromRevenueLineId) and its market assumptions in Tools › Products at company scope. annualSalesUsd joins the company's annual revenue, re-dividing every line's share while the others keep their sales; marketSharePct and aiInfluencePct (default 20) set its AI-influenced sales and market as saved assumptions, so resetting them leaves the unresearched line without economics. Customers come from it once customer generation next prepares the profile, reviewing its audiences first. INVALID_INPUT when the profile has no annual revenue or its most products; STALE_WRITE when it changed meanwhile. Answers the company ledger as business_revenue_tracking_workspaces_get_v2 reads it, without the measured win rate.","tags":["business"],"x-cli-name":"business-revenue-lines-create-v2","x-point11-scope":"business:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRevenueLinesCreateV2Request"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRevenueLinesCreateV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/revenue-lines/create":{"post":{"operationId":"business.revenue-lines.create.v1","summary":"Create revenue lines","description":"Deprecated: use business.revenue-lines.create.v2 (business_revenue_lines_create_v2), whose ledger states each line's AI-influenced sales. This version adds the same line and answers the ledger in its published shape: onePointWinRateValueUsd is the line's one point of win rate, AI-influenced SAM ÷ 100, whatever Discovery measured.","deprecated":true,"tags":["business"],"x-cli-name":"business-revenue-lines-create","x-point11-scope":"business:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRevenueLinesCreateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessRevenueLinesCreateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/goals":{"get":{"operationId":"business.goals.list.v1","summary":"List goals","description":"List a business profile's goals (by its id or profile key, or \"default\" for the one business_profile_selections_get selects by default), oldest first: each goal's metric, target and due date, the reading it started from, the metric's current reading and history from the product that owns it, and its status (reached, on track, behind, below target for an ongoing goal or one with no baseline to pace from, missed, stale, or no reading yet; within_margin is no goal's status any more, since no reading carries a margin of error, and each reading's low and high equal its value). Archived goals are included only when includeArchived is true.","tags":["business"],"x-cli-name":"business-goals-list","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"businessProfileId","in":"query","required":true,"description":"The business profile: its id or profile key, or \"default\" for the profile business.profile-selections.get.v1 selects by default","schema":{"type":"string","description":"The business profile: its id or profile key, or \"default\" for the profile business.profile-selections.get.v1 selects by default"}},{"name":"includeArchived","in":"query","required":false,"schema":{"default":false,"type":"boolean"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessGoalsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/goals/{id}":{"get":{"operationId":"business.goals.get.v1","summary":"Get goals","description":"Read one goal with its current reading, history, pace and status, as business_goals_list reports each goal.","tags":["business"],"x-cli-name":"business-goals-get","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessGoalsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/goals/create":{"post":{"operationId":"business.goals.create.v1","summary":"Create goals","description":"Set a goal: a target for one metric of a business profile, by a due date or ongoing (no due date: a target to reach and keep). Discovery brand win rate, Discovery brand share, and Experience journey pass rate name their campaign; Google Ads Quality Score names its account; Inspector score reads the profile's website. business_goal_subjects_list lists what the profile can set a goal on. The goal records the metric's current reading as its baseline.","tags":["business"],"x-cli-name":"business-goals-create","x-point11-scope":"business:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessGoalsCreateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessGoalsCreateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/goals/update":{"post":{"operationId":"business.goals.update.v1","summary":"Update goals","description":"Change a goal's target and due date (null makes it ongoing). Pass the goal's current revision as expectedRevision; if it changed since you read it, this fails with STALE_WRITE and you re-read the goal. The metric, subject, and baseline never change: set a new goal instead.","tags":["business"],"x-cli-name":"business-goals-update","x-point11-scope":"business:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessGoalsUpdateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessGoalsUpdateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/goals/archive":{"post":{"operationId":"business.goals.archive.v1","summary":"Archive goals","description":"Archive a goal: it leaves the profile's goal list and the organization's goal summary, and keeps its history. Pass the goal's current revision as expectedRevision.","tags":["business"],"x-cli-name":"business-goals-archive","x-point11-scope":"business:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessGoalsArchiveRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessGoalsArchiveResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/goals/restore":{"post":{"operationId":"business.goals.restore.v1","summary":"Restore goals","description":"Restore an archived goal to the profile's goal list. Pass the goal's current revision as expectedRevision.","tags":["business"],"x-cli-name":"business-goals-restore","x-point11-scope":"business:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessGoalsRestoreRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessGoalsRestoreResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/goals/delete":{"post":{"operationId":"business.goals.delete.v1","summary":"Delete goals","description":"Delete a goal permanently. Pass the goal's current revision as expectedRevision; if it changed since you read it, nothing is deleted and this fails with STALE_WRITE.","tags":["business"],"x-cli-name":"business-goals-delete","x-point11-scope":"business:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessGoalsDeleteRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessGoalsDeleteResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/goal-subjects":{"get":{"operationId":"business.goal-subjects.list.v1","summary":"List goal subjects","description":"List what a business profile can set a goal on: each metric with the campaign, Google Ads account, or website it reads, that subject's current reading (its low and high equal its value: no reading carries a margin of error), and, for Discovery brand win rate with Tools › Products market assumptions, the modeled annual value of one point.","tags":["business"],"x-cli-name":"business-goal-subjects-list","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"businessProfileId","in":"query","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"readings","in":"query","required":false,"description":"False lists the subjects without reading them, each `current` and `onePointUsd` null, so a form can offer every subject and read only the one chosen. Default true.","schema":{"description":"False lists the subjects without reading them, each `current` and `onePointUsd` null, so a form can offer every subject and read only the one chosen. Default true.","type":"boolean"}},{"name":"metric","in":"query","required":false,"description":"Narrow the list to the one subject this metric reads with `campaignId` or `googleAdsAccountId` (absent where the metric reads neither).","schema":{"description":"Narrow the list to the one subject this metric reads with `campaignId` or `googleAdsAccountId` (absent where the metric reads neither).","type":"string","enum":["discovery_brand_win_rate","discovery_brand_share","experience_pass_rate","inspector_score","google_ads_quality_score"]}},{"name":"campaignId","in":"query","required":false,"description":"The narrowed subject's campaign; needs `metric`.","schema":{"description":"The narrowed subject's campaign; needs `metric`.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"googleAdsAccountId","in":"query","required":false,"description":"The narrowed subject's Google Ads account; needs `metric`.","schema":{"description":"The narrowed subject's Google Ads account; needs `metric`.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessGoalSubjectsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/goal-summaries/{id}":{"get":{"operationId":"business.goal-summaries.get.v1","summary":"Get goal summaries","description":"Summarize the organization's unarchived goals across its active business profiles: how many are reached, on track, behind, below target, missed, stale, or without a reading yet (within_margin always counts 0: no goal reads it any more), and which goals are behind. Pass \"organization\" as the id.","tags":["business"],"x-cli-name":"business-goal-summaries-get","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","const":"organization"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessGoalSummariesGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/google-ads-connections/{id}":{"get":{"operationId":"business.google-ads-connections.get.v1","summary":"Get google ads connections","description":"Read the organization's Google Ads connection (id \"organization\"): whether this environment can connect Google Ads, the connection's state, and every Ads account it reaches with whether Point11 reads it, the last day synced, and the last sync's failure code.","tags":["business"],"x-cli-name":"business-google-ads-connections-get","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","const":"organization"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessGoogleAdsConnectionsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/google-ads-accounts/discover":{"post":{"operationId":"business.google-ads-accounts.discover.v1","summary":"Discover google ads accounts","description":"Ask Google again which Ads accounts the organization's connection reaches, adding new ones as available and marking selected ones it no longer reaches.","tags":["business"],"x-cli-name":"business-google-ads-accounts-discover","x-point11-scope":"business:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessGoogleAdsAccountsDiscoverRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessGoogleAdsAccountsDiscoverResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/google-ads-accounts/select":{"post":{"operationId":"business.google-ads-accounts.select.v1","summary":"Select google ads accounts","description":"Choose which Google Ads accounts Point11 reads, by 10-digit customer id; the list replaces the current selection. Newly chosen accounts start their first Quality Score sync, which backfills 90 days.","tags":["business"],"x-cli-name":"business-google-ads-accounts-select","x-point11-scope":"business:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessGoogleAdsAccountsSelectRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessGoogleAdsAccountsSelectResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/google-ads-accounts/sync":{"post":{"operationId":"business.google-ads-accounts.sync.v1","summary":"Sync google ads accounts","description":"Refresh Quality Score from Google for one selected Google Ads account (by account id), or for every selected account when no id is given. With from and through (an editor, admin, or owner), read those days from Google, once per account per 15-minute window: a range asked in a window that already read one is answered by that read. Without them, an account refreshed in the last 15 minutes is left alone. The result names the accounts queued and the start of the 15-minute refresh window the request shares: each is refreshed once its last sync attempt passes it. Accounts also refresh daily on their own and whenever a member opens Google Ads.","tags":["business"],"x-cli-name":"business-google-ads-accounts-sync","x-point11-scope":"business:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessGoogleAdsAccountsSyncRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessGoogleAdsAccountsSyncResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/google-ads-quality-scores/{id}":{"get":{"operationId":"business.google-ads-quality-scores.get.v1","summary":"Get google ads quality scores","description":"Read one Google Ads account's Quality Score (the organization's first selected account when none is named) over the last N account-local days ending yesterday, a chosen range, or with history \"all\" its whole stored history (at most 400 days): the impression-weighted score and its first- and last-week values, current keywords per score 1-10 and how many Google left unscored, the share of cost on keywords scored 5 or lower, impression shares of each component rating, and the daily weighted trend.","tags":["business"],"x-cli-name":"business-google-ads-quality-scores-get","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"days","in":"query","required":false,"schema":{"default":30,"type":"integer","minimum":7,"maximum":365}},{"name":"from","in":"query","required":false,"schema":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"}},{"name":"through","in":"query","required":false,"schema":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"}},{"name":"history","in":"query","required":false,"schema":{"type":"string","const":"all"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessGoogleAdsQualityScoresGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/google-ads-keywords":{"get":{"operationId":"business.google-ads-keywords.list.v1","summary":"List google ads keywords","description":"List one Google Ads account's current Search keywords (the organization's first selected account when none is named, returned as accountId) with Google's Quality Score and its three components, the score 7 and 30 days ago, and the window's impressions, clicks, and cost (history \"all\": its whole stored history). Sort by cost (default), score, impressions, or change; filter to keywords scored at or below a value.","tags":["business"],"x-cli-name":"business-google-ads-keywords-list","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"accountId","in":"query","required":false,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"days","in":"query","required":false,"schema":{"default":30,"type":"integer","minimum":7,"maximum":365}},{"name":"maxQualityScore","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":10}},{"name":"query","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":200}},{"name":"from","in":"query","required":false,"schema":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"}},{"name":"through","in":"query","required":false,"schema":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"}},{"name":"history","in":"query","required":false,"schema":{"type":"string","const":"all"}},{"name":"sort","in":"query","required":false,"schema":{"default":"cost","type":"string","enum":["cost","quality_score","impressions","change"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessGoogleAdsKeywordsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/google-ads-search-terms":{"get":{"operationId":"business.google-ads-search-terms.list.v1","summary":"List google ads search terms","description":"List one Google Ads account's search terms (the organization's first selected account when none is named, returned as accountId): what people searched that showed an ad, per keyword that matched it, with the window's impressions, clicks, and cost (history \"all\": its whole stored history), beside that keyword's current Quality Score and its three components (a search term has no score of its own). Sort by cost (default) or the keyword's score; filter to keywords scored at or below a value; search the terms' text.","tags":["business"],"x-cli-name":"business-google-ads-search-terms-list","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"accountId","in":"query","required":false,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"days","in":"query","required":false,"schema":{"default":30,"type":"integer","minimum":7,"maximum":365}},{"name":"maxQualityScore","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":10}},{"name":"query","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":200}},{"name":"from","in":"query","required":false,"schema":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"}},{"name":"through","in":"query","required":false,"schema":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"}},{"name":"history","in":"query","required":false,"schema":{"type":"string","const":"all"}},{"name":"sort","in":"query","required":false,"schema":{"default":"cost","type":"string","enum":["cost","quality_score"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessGoogleAdsSearchTermsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/google-ads-destinations/{id}":{"get":{"operationId":"business.google-ads-destinations.get.v1","summary":"Get google ads destinations","description":"Read live from Google the Search and Display campaigns and ad groups of one selected Google Ads account (the organization's first selected account when none is named) that a confirmed paused ad draft may go into. Reading changes nothing in Google Ads.","tags":["business"],"x-cli-name":"business-google-ads-destinations-get","x-point11-scope":"business:read","security":[{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"A selected account's id, or \"selected\" for the organization's first selected account","schema":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"string","const":"selected"}],"description":"A selected account's id, or \"selected\" for the organization's first selected account"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessGoogleAdsDestinationsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/outcome-connections/{id}":{"get":{"operationId":"business.outcome-connections.get.v1","summary":"Get outcome connections","description":"Deprecated: use business.outcome-connections.get.v2 (business_outcome_connections_get_v2), which also reads a Shopify connection (\"shopify\") and names its shops (kind \"shopify_shop\"); this version reads \"google_analytics\" and \"vercel_web_analytics\" only. Read one of the organization's results connections by its source (id \"google_analytics\": one Google sign-in that reaches Google Analytics properties; \"vercel_web_analytics\": one Vercel sign-in that reaches Vercel projects with Web Analytics): whether this environment can connect it, the connection's state, and every source it reaches with whether Point11 reads it, the last day checked, and the last check's failure code.","deprecated":true,"tags":["business"],"x-cli-name":"business-outcome-connections-get","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","enum":["google_analytics","vercel_web_analytics"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessOutcomeConnectionsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/outcome-connections-v2/{id}":{"get":{"operationId":"business.outcome-connections.get.v2","summary":"Get outcome connections (v2)","description":"Read one of the organization's results connections by its source (id \"google_analytics\": one Google sign-in that reaches Google Analytics properties; \"vercel_web_analytics\": one Vercel sign-in that reaches Vercel projects with Web Analytics; \"shopify\": one install of the organization's Point11 Shopify app, which reaches one shop): whether this environment can connect it, the connection's state, and every source it reaches with whether Point11 reads it, the last day checked, and the last check's failure code.","tags":["business"],"x-cli-name":"business-outcome-connections-get-v2","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","enum":["google_analytics","vercel_web_analytics","shopify"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessOutcomeConnectionsGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/outcome-connections":{"get":{"operationId":"business.outcome-connections.list.v1","summary":"List outcome connections","description":"List every one of the organization's results connections, one entry per source (\"google_analytics\", \"vercel_web_analytics\" and \"shopify\", always all three, in that order, one page), each as business_outcome_connections_get_v2 reads it: whether this environment can connect it, the connection's state, and every source it reaches with whether Point11 reads it, the last day checked, and the last check's failure code.","tags":["business"],"x-cli-name":"business-outcome-connections-list","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessOutcomeConnectionsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/outcome-sources/discover":{"post":{"operationId":"business.outcome-sources.discover.v1","summary":"Discover outcome sources","description":"Ask the provider again which sources the organization's connection reaches, adding new ones as available and marking selected ones it no longer reaches.","tags":["business"],"x-cli-name":"business-outcome-sources-discover","x-point11-scope":"business:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessOutcomeSourcesDiscoverRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessOutcomeSourcesDiscoverResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/outcome-sources/select":{"post":{"operationId":"business.outcome-sources.select.v1","summary":"Select outcome sources","description":"Choose which of one connection's sources Point11 reads (source \"google_analytics\", \"vercel_web_analytics\", or \"shopify\"), by source id; the list replaces that connection's selection and leaves the others' as they are. A newly chosen source starts its first check, which reads back 13 months, or as far as the provider keeps.","tags":["business"],"x-cli-name":"business-outcome-sources-select","x-point11-scope":"business:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessOutcomeSourcesSelectRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessOutcomeSourcesSelectResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/outcome-sources/check":{"post":{"operationId":"business.outcome-sources.check.v1","summary":"Check outcome sources","description":"Queue a check now for one selected source (by source id), or for every selected source when no id is given. Checks also run daily on their own and read each day once it is three days old.","tags":["business"],"x-cli-name":"business-outcome-sources-check","x-point11-scope":"business:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessOutcomeSourcesCheckRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessOutcomeSourcesCheckResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/outcome-results/{id}":{"get":{"operationId":"business.outcome-results.get.v1","summary":"Get outcome results","description":"Deprecated: use business.outcome-results.get.v2 (business_outcome_results_get_v2), which also reads a Shopify shop; this version leaves out a Shopify connection and its shops, as if they were not connected, so with no source named it reads the first selected Google Analytics property or Vercel project. Read the organization's real-world results (id \"organization\") over the newest N days one source (the first selected when none is named) is checked through, beside the N days before them: every visit and the visits AI assistants sent, by day, by assistant, and by landing page, with the key events and purchase revenue of each. A Google Analytics property counts sessions and reports key events and revenue; a Vercel project counts daily visitors and reports neither, so they read null. Every number is the provider's own daily total.","deprecated":true,"tags":["business"],"x-cli-name":"business-outcome-results-get","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","const":"organization"}},{"name":"sourceId","in":"query","required":false,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"days","in":"query","required":false,"schema":{"default":90,"type":"integer","minimum":7,"maximum":180}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessOutcomeResultsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/outcome-results-v2/{id}":{"get":{"operationId":"business.outcome-results.get.v2","summary":"Get outcome results (v2)","description":"Read the organization's real-world results (id \"organization\") over the newest N days one source (the first selected when none is named) is checked through, beside the N days before them: every visit and the visits AI assistants sent, by day, by assistant, and by landing page, with the key events and purchase revenue of each. A Google Analytics property counts sessions and reports key events and revenue; a Shopify shop counts online store sessions and reports orders as its key events and total sales as its revenue, in its own time zone; a Vercel project counts daily visitors and reports neither, so they read null. Every number is the provider's own daily total.","tags":["business"],"x-cli-name":"business-outcome-results-get-v2","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","const":"organization"}},{"name":"sourceId","in":"query","required":false,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"days","in":"query","required":false,"schema":{"default":90,"type":"integer","minimum":7,"maximum":180}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessOutcomeResultsGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/outcome-page-changes/measure":{"post":{"operationId":"business.outcome-page-changes.measure.v1","summary":"Measure outcome page changes","description":"Deprecated: use business.outcome-page-changes.measure.v2 (business_outcome_page_changes_measure_v2), which also measures in a Shopify shop; this version leaves out a Shopify shop, measuring in the first chosen Google Analytics property or Vercel project, so an organization that reads only a Shopify shop answers each change not_connected. Measure how AI-assistant visits to sets of changed pages moved against the rest of the site's AI-assistant visits, before and after each change. Each change names its pages (URLs or paths) and the days the change went live between; the answer compares up to 56 days before with up to 56 days after and reports the relative change with an approximate 90% range, or says why it cannot (not connected, too early, too few visits, nothing to compare with). It measures a provider's visit counts only and changes nothing; it is sent as a write only because each change is an object.","deprecated":true,"tags":["business"],"x-cli-name":"business-outcome-page-changes-measure","x-point11-scope":"business:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessOutcomePageChangesMeasureRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessOutcomePageChangesMeasureResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/outcome-page-changes/measure-v2":{"post":{"operationId":"business.outcome-page-changes.measure.v2","summary":"Measure outcome page changes (v2)","description":"Measure how AI-assistant visits to sets of changed pages moved against the rest of the site's AI-assistant visits, before and after each change, in the organization's first chosen source (a Google Analytics property, a Shopify shop, or a Vercel project). Each change names its pages (URLs or paths) and the days the change went live between; the answer compares up to 56 days before with up to 56 days after and reports the relative change with an approximate 90% range, or says why it cannot (not connected, too early, too few visits, nothing to compare with). It measures a provider's visit counts only and changes nothing; it is sent as a write only because each change is an object.","tags":["business"],"x-cli-name":"business-outcome-page-changes-measure-v2","x-point11-scope":"business:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessOutcomePageChangesMeasureV2Request"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessOutcomePageChangesMeasureV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/outcome-series":{"get":{"operationId":"business.outcome-series.list.v1","summary":"List outcome series","description":"List the organization's imported series in Outcomes (the daily numbers a member brought in that no connected source reports, such as net sales from an export or deals a CRM closed), oldest first, one page: each one's name, how it came in (custom or crm_import), whether a day's value adds over days (total) or is a reading at the day's end (level), its unit and currency, whether each day is split into what AI assistants referred and the rest (split \"channel\"), and its coverage: the first and last day with a value and how many days have one.","tags":["business"],"x-cli-name":"business-outcome-series-list","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessOutcomeSeriesListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/outcome-series/create":{"post":{"operationId":"business.outcome-series.create.v1","summary":"Create outcome series","description":"Add an empty imported series to Outcomes, then send its days with business_outcome_series_values_import. Name it (unique in the organization) and say what a day's value is: kind \"total\" adds over days (sales, orders, leads), \"level\" is a reading at the day's end (active subscribers); unit \"currency\" (with its ISO 4217 code) or \"count\"; split \"channel\" when each day carries what AI assistants referred (ai) and the rest (other), else \"none\". Days are calendar days as the data dates them; every value is a day's total, never a person.","tags":["business"],"x-cli-name":"business-outcome-series-create","x-point11-scope":"business:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessOutcomeSeriesCreateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessOutcomeSeriesCreateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/outcome-series/delete":{"post":{"operationId":"business.outcome-series.delete.v1","summary":"Delete outcome series","description":"Delete one imported series by id, with every day of its values and every Outcomes pairing that reads it.","tags":["business"],"x-cli-name":"business-outcome-series-delete","x-point11-scope":"business:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessOutcomeSeriesDeleteRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessOutcomeSeriesDeleteResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/outcome-series-values/import":{"post":{"operationId":"business.outcome-series-values.import.v1","summary":"Import outcome series values","description":"Send an imported series' daily values, up to 1,830 days a call (a longer history in parts). Each day is a date and its value, or, for a series split by channel, its ai and other values. Mode \"replace\" deletes every stored day from the first to the last day sent and writes what was sent, so a corrected export replaces its range; \"merge\" writes the days sent over the stored ones and keeps the rest. A day not sent is unknown, never zero, and a week missing a day of a total is left out of Outcomes's weeks. Send the newest days daily to keep a pairing's weeks current.","tags":["business"],"x-cli-name":"business-outcome-series-values-import","x-point11-scope":"business:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessOutcomeSeriesValuesImportRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessOutcomeSeriesValuesImportResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/outcome-crm-syncs":{"get":{"operationId":"business.outcome-crm-syncs.list.v1","summary":"List outcome crm syncs","description":"List the organization's CRM syncs in Outcomes, at most one per CRM (HubSpot, Salesforce): what each keeps of the CRM's won deals (deals, how many were won each day; revenue, their summed amount in the CRM's currency), the last day a committed read covered, when a read last finished, and its failure code while the last read failed. A sync's series appear in business_outcome_series_list once its first read commits.","tags":["business"],"x-cli-name":"business-outcome-crm-syncs-list","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessOutcomeCrmSyncsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/outcome-crm-syncs/create":{"post":{"operationId":"business.outcome-crm-syncs.create.v1","summary":"Create outcome crm syncs","description":"Start syncing a connected CRM's won deals (HubSpot deals, Salesforce opportunities) into Outcomes as daily series, or add a measure to its sync: deals (how many were won each day, by close date) and revenue (their summed amount, in the CRM's own currency); both by default. The CRM must be connected in Settings › Connections. The first read covers about thirteen months and runs at once; afterwards each day re-reads the last month, since deals are often marked won late. Only daily totals reach Point11, never a deal, account or person.","tags":["business"],"x-cli-name":"business-outcome-crm-syncs-create","x-point11-scope":"business:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessOutcomeCrmSyncsCreateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessOutcomeCrmSyncsCreateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/outcome-crm-syncs/delete":{"post":{"operationId":"business.outcome-crm-syncs.delete.v1","summary":"Delete outcome crm syncs","description":"Stop one CRM sync by id: it, its series with every day of their values, and every Outcomes pairing that reads them are deleted. The CRM connection itself stays.","tags":["business"],"x-cli-name":"business-outcome-crm-syncs-delete","x-point11-scope":"business:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessOutcomeCrmSyncsDeleteRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessOutcomeCrmSyncsDeleteResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/outcome-pairing-choices/{id}":{"get":{"operationId":"business.outcome-pairing-choices.get.v1","summary":"Get outcome pairing choices","description":"Read what an Outcomes pairing can compare (id \"organization\"): the organization's Discovery campaigns (their Brand Win Rate and Brand Share are signals), the connected sources it reads with the measures each reports (sessions; key events and revenue where the provider reports them), and its imported series, each as business_outcome_series_list lists it.","tags":["business"],"x-cli-name":"business-outcome-pairing-choices-get","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","const":"organization"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessOutcomePairingChoicesGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/outcome-pairings":{"get":{"operationId":"business.outcome-pairings.list.v1","summary":"List outcome pairings","description":"List the tracked Outcomes pairings, oldest first, one page, each measured now from the stored daily numbers: how strongly the outcome moved after the signal moved. Weeks (Monday to Sunday) are rebuilt from daily counts, each series becomes its week-over-week change, and the outcome's change is set against the signal's change 0 to 8 weeks earlier; an outcome read from AI assistants is compared with its other channel, which carries the season and promotions both share. The lag is chosen on the earlier weeks and checked on the later ones, and the 95% range comes from a seeded moving-block bootstrap. Each pairing answers a label: collecting (fewer than 16 paired weeks), inconclusive (the range spans no link and a meaningful one), no_meaningful_link (the range lies inside ±0.3), suggestive, or consistent (the pinned pairing only: its range excludes zero and held on the later weeks); exploratory pairings are corrected together for false discoveries. It also answers the correlation, the percent change in the outcome per point (or per 1%) of the signal with its range, the weeks, the smallest correlation those weeks can detect, the signal's reliability, the weekly series, and one sentence. Every result is an association between numbers, never proof of cause.","tags":["business"],"x-cli-name":"business-outcome-pairings-list","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessOutcomePairingsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/outcome-pairings/create":{"post":{"operationId":"business.outcome-pairings.create.v1","summary":"Create outcome pairings","description":"Start tracking an Outcomes pairing: a signal (a Discovery campaign's Brand Win Rate or Brand Share, or another outcome) and the outcome it may move (a connected source's sessions, key events or revenue, or an imported series' value, for all of it or the channel AI assistants referred), choosing from business_outcome_pairing_choices_get. It is measured at once from the history already stored and every day after. Pinned makes it the organization's one main test, tested alone (any other pin is lifted). Up to 25 pairings.","tags":["business"],"x-cli-name":"business-outcome-pairings-create","x-point11-scope":"business:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessOutcomePairingsCreateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessOutcomePairingsCreateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/outcome-pairings/update":{"post":{"operationId":"business.outcome-pairings.update.v1","summary":"Update outcome pairings","description":"Pin one Outcomes pairing by id as the organization's main test (lifting any other pin), or unpin it. A pinned pairing is tested alone; the others are corrected together as exploratory.","tags":["business"],"x-cli-name":"business-outcome-pairings-update","x-point11-scope":"business:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessOutcomePairingsUpdateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessOutcomePairingsUpdateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/outcome-pairings/delete":{"post":{"operationId":"business.outcome-pairings.delete.v1","summary":"Delete outcome pairings","description":"Stop tracking one Outcomes pairing by id. The numbers it read stay where they are.","tags":["business"],"x-cli-name":"business-outcome-pairings-delete","x-point11-scope":"business:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessOutcomePairingsDeleteRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessOutcomePairingsDeleteResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/customers-v2":{"get":{"operationId":"business.customers.list.v2","summary":"List customers (v2)","description":"Deprecated: use business.customers.list.v3 (business_customers_list_v3), which names no faviconLightUrl or faviconDarkUrl: a favicon is one image for both themes, faviconUrl. This version answers the same and names both, never sent. List the organization's customers (active ones by default), optionally for one business profile or one of its stores (locationKey), newest first unless sorted: each one's name, its table attributes under the customer model's keys (a category, a band as <key>.band, the Product and the Buyer type each as its id and label; Location as one line), audiences, sources, and latest Discovery outcome, with the pool's status counts and audience facets. Filter by lifecycle status, name search, audience names and field conditions; page with nextCursor.","deprecated":true,"tags":["business"],"x-cli-name":"business-customers-list-v2","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"default":20,"type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024}},{"name":"businessProfileId","in":"query","required":false,"description":"Only this business profile's customers; omit for every profile","schema":{"description":"Only this business profile's customers; omit for every profile","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"locationKey","in":"query","required":false,"description":"Only the customers generated for this store: a store profile's location key, as business_store_profile_summaries_get_v1 lists them under its businessProfileId","schema":{"description":"Only the customers generated for this store: a store profile's location key, as business_store_profile_summaries_get_v1 lists them under its businessProfileId","type":"string","minLength":1,"maxLength":500}},{"name":"lifecycleStatus","in":"query","required":false,"schema":{"default":"active","type":"string","enum":["active","archived","all"]}},{"name":"search","in":"query","required":false,"description":"Match the customer's name","schema":{"default":"","description":"Match the customer's name","type":"string","maxLength":200}},{"name":"audienceNames","in":"query","required":false,"description":"Source and label names: only customers in any named source and in any named label (system audiences are labels); a kind none names narrows nothing","schema":{"default":[],"description":"Source and label names: only customers in any named source and in any named label (system audiences are labels); a kind none names narrows nothing","maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":160}}},{"name":"customerIds","in":"query","required":false,"description":"Only these customers, under every other filter","schema":{"description":"Only these customers, under every other filter","minItems":1,"maxItems":1000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},{"name":"includeEditable","in":"query","required":false,"description":"Also answer the page's customers as business_customers_update_v4 edits them (edits): each one's version, editable fields and their options","schema":{"default":false,"description":"Also answer the page's customers as business_customers_update_v4 edits them (edits): each one's version, editable fields and their options","type":"boolean"}},{"name":"sort","in":"query","required":false,"schema":{"default":"createdAt","type":"string","enum":["createdAt","customerId","name","profile","performance","audiences","sources","status","gender","age","language","location","householdIncome","employer","companySize","annualRevenue","intentStage","trigger"]}},{"name":"direction","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}},{"name":"filters","in":"query","required":false,"description":"Field conditions, each `<field>:<operator>:<value>`. Text fields (location, employer, trigger) take contains, does_not_contain, is or starts_with and the words. Number fields (age, householdIncome, companySize, annualRevenue) take gt, gte, lt, lte or eq and a number, or between and `min..max`. Classification fields, each band under its fact's key as <key>.band (gender, age.band, language, market, areaType, education, lifeStage, householdIncome.band, occupation, seniority, companySize.band, buyerType, audience, product, channel, buyerRole, intentStage, job, triggerType), take is_any_of or is_none_of and comma-separated ids from business_customer_filter_options_get_v2 (buyerType takes consumer or organization), `none` for a customer with no value. createdAt takes on_or_after or on_or_before and an ISO date, or between and `from..to`, read in UTC. performance (the latest Discovery outcome) takes is_any_of or is_none_of and won, lost or `none`.","schema":{"description":"Field conditions, each `<field>:<operator>:<value>`. Text fields (location, employer, trigger) take contains, does_not_contain, is or starts_with and the words. Number fields (age, householdIncome, companySize, annualRevenue) take gt, gte, lt, lte or eq and a number, or between and `min..max`. Classification fields, each band under its fact's key as <key>.band (gender, age.band, language, market, areaType, education, lifeStage, householdIncome.band, occupation, seniority, companySize.band, buyerType, audience, product, channel, buyerRole, intentStage, job, triggerType), take is_any_of or is_none_of and comma-separated ids from business_customer_filter_options_get_v2 (buyerType takes consumer or organization), `none` for a customer with no value. createdAt takes on_or_after or on_or_before and an ISO date, or between and `from..to`, read in UTC. performance (the latest Discovery outcome) takes is_any_of or is_none_of and won, lost or `none`.","maxItems":20,"type":"array","items":{"type":"string","minLength":5,"maxLength":4000,"pattern":"^[A-Za-z]+(?:\\.band)?:[a-z_]+:.+$"}}},{"name":"filterMatch","in":"query","required":false,"description":"Whether a customer matches every condition (all, the default) or any one","schema":{"description":"Whether a customer matches every condition (all, the default) or any one","type":"string","enum":["all","any"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomersListV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/customers-v3":{"get":{"operationId":"business.customers.list.v3","summary":"List customers (v3)","description":"List the organization's customers (active ones by default), optionally for one business profile or one of its stores (locationKey), newest first unless sorted: each one's name, its table attributes under the customer model's keys (a category, a band as <key>.band, the Product and the Buyer type each as its id and label; Location as one line), audiences, sources, and latest Discovery outcome, with the pool's status counts and audience facets. Filter by lifecycle status, name search, audience names and field conditions; page with nextCursor.","tags":["business"],"x-cli-name":"business-customers-list-v3","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"default":20,"type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024}},{"name":"businessProfileId","in":"query","required":false,"description":"Only this business profile's customers; omit for every profile","schema":{"description":"Only this business profile's customers; omit for every profile","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"locationKey","in":"query","required":false,"description":"Only the customers generated for this store: a store profile's location key, as business_store_profile_summaries_get_v1 lists them under its businessProfileId","schema":{"description":"Only the customers generated for this store: a store profile's location key, as business_store_profile_summaries_get_v1 lists them under its businessProfileId","type":"string","minLength":1,"maxLength":500}},{"name":"lifecycleStatus","in":"query","required":false,"schema":{"default":"active","type":"string","enum":["active","archived","all"]}},{"name":"search","in":"query","required":false,"description":"Match the customer's name","schema":{"default":"","description":"Match the customer's name","type":"string","maxLength":200}},{"name":"audienceNames","in":"query","required":false,"description":"Source and label names: only customers in any named source and in any named label (system audiences are labels); a kind none names narrows nothing","schema":{"default":[],"description":"Source and label names: only customers in any named source and in any named label (system audiences are labels); a kind none names narrows nothing","maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":160}}},{"name":"customerIds","in":"query","required":false,"description":"Only these customers, under every other filter","schema":{"description":"Only these customers, under every other filter","minItems":1,"maxItems":1000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},{"name":"includeEditable","in":"query","required":false,"description":"Also answer the page's customers as business_customers_update_v4 edits them (edits): each one's version, editable fields and their options","schema":{"default":false,"description":"Also answer the page's customers as business_customers_update_v4 edits them (edits): each one's version, editable fields and their options","type":"boolean"}},{"name":"sort","in":"query","required":false,"schema":{"default":"createdAt","type":"string","enum":["createdAt","customerId","name","profile","performance","audiences","sources","status","gender","age","language","location","householdIncome","employer","companySize","annualRevenue","intentStage","trigger"]}},{"name":"direction","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}},{"name":"filters","in":"query","required":false,"description":"Field conditions, each `<field>:<operator>:<value>`. Text fields (location, employer, trigger) take contains, does_not_contain, is or starts_with and the words. Number fields (age, householdIncome, companySize, annualRevenue) take gt, gte, lt, lte or eq and a number, or between and `min..max`. Classification fields, each band under its fact's key as <key>.band (gender, age.band, language, market, areaType, education, lifeStage, householdIncome.band, occupation, seniority, companySize.band, buyerType, audience, product, channel, buyerRole, intentStage, job, triggerType), take is_any_of or is_none_of and comma-separated ids from business_customer_filter_options_get_v2 (buyerType takes consumer or organization), `none` for a customer with no value. createdAt takes on_or_after or on_or_before and an ISO date, or between and `from..to`, read in UTC. performance (the latest Discovery outcome) takes is_any_of or is_none_of and won, lost or `none`.","schema":{"description":"Field conditions, each `<field>:<operator>:<value>`. Text fields (location, employer, trigger) take contains, does_not_contain, is or starts_with and the words. Number fields (age, householdIncome, companySize, annualRevenue) take gt, gte, lt, lte or eq and a number, or between and `min..max`. Classification fields, each band under its fact's key as <key>.band (gender, age.band, language, market, areaType, education, lifeStage, householdIncome.band, occupation, seniority, companySize.band, buyerType, audience, product, channel, buyerRole, intentStage, job, triggerType), take is_any_of or is_none_of and comma-separated ids from business_customer_filter_options_get_v2 (buyerType takes consumer or organization), `none` for a customer with no value. createdAt takes on_or_after or on_or_before and an ISO date, or between and `from..to`, read in UTC. performance (the latest Discovery outcome) takes is_any_of or is_none_of and won, lost or `none`.","maxItems":20,"type":"array","items":{"type":"string","minLength":5,"maxLength":4000,"pattern":"^[A-Za-z]+(?:\\.band)?:[a-z_]+:.+$"}}},{"name":"filterMatch","in":"query","required":false,"description":"Whether a customer matches every condition (all, the default) or any one","schema":{"description":"Whether a customer matches every condition (all, the default) or any one","type":"string","enum":["all","any"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomersListV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/customer-pool-selections":{"get":{"operationId":"business.customer-pool-selections.list.v1","summary":"List customer pool selections","description":"List every customer business_customers_list_v3 lists under the same businessProfileId, locationKey, lifecycleStatus, search, audienceNames and filters, by id alone: each one's id, pool status and source, up to 1,000 a page in id order (page with nextCursor). It is what selecting every matching customer selects, never their content; read the customers themselves through business_customers_list_v3's customerIds.","tags":["business"],"x-cli-name":"business-customer-pool-selections-list","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"default":1000,"type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024}},{"name":"businessProfileId","in":"query","required":false,"description":"Only this business profile's customers; omit for every profile","schema":{"description":"Only this business profile's customers; omit for every profile","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"locationKey","in":"query","required":false,"description":"Only the customers generated for this store: a store profile's location key, as business_store_profile_summaries_get_v1 lists them under its businessProfileId","schema":{"description":"Only the customers generated for this store: a store profile's location key, as business_store_profile_summaries_get_v1 lists them under its businessProfileId","type":"string","minLength":1,"maxLength":500}},{"name":"lifecycleStatus","in":"query","required":false,"schema":{"default":"active","type":"string","enum":["active","archived","all"]}},{"name":"search","in":"query","required":false,"description":"Match the customer's name","schema":{"default":"","description":"Match the customer's name","type":"string","maxLength":200}},{"name":"audienceNames","in":"query","required":false,"description":"Source and label names, as business_customers_list_v3 takes them: only customers in any named source and in any named label","schema":{"default":[],"description":"Source and label names, as business_customers_list_v3 takes them: only customers in any named source and in any named label","maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":160}}},{"name":"filters","in":"query","required":false,"description":"Field conditions, each `<field>:<operator>:<value>`. Text fields (location, employer, trigger) take contains, does_not_contain, is or starts_with and the words. Number fields (age, householdIncome, companySize, annualRevenue) take gt, gte, lt, lte or eq and a number, or between and `min..max`. Classification fields, each band under its fact's key as <key>.band (gender, age.band, language, market, areaType, education, lifeStage, householdIncome.band, occupation, seniority, companySize.band, buyerType, audience, product, channel, buyerRole, intentStage, job, triggerType), take is_any_of or is_none_of and comma-separated ids from business_customer_filter_options_get_v2 (buyerType takes consumer or organization), `none` for a customer with no value. createdAt takes on_or_after or on_or_before and an ISO date, or between and `from..to`, read in UTC. performance (the latest Discovery outcome) takes is_any_of or is_none_of and won, lost or `none`.","schema":{"description":"Field conditions, each `<field>:<operator>:<value>`. Text fields (location, employer, trigger) take contains, does_not_contain, is or starts_with and the words. Number fields (age, householdIncome, companySize, annualRevenue) take gt, gte, lt, lte or eq and a number, or between and `min..max`. Classification fields, each band under its fact's key as <key>.band (gender, age.band, language, market, areaType, education, lifeStage, householdIncome.band, occupation, seniority, companySize.band, buyerType, audience, product, channel, buyerRole, intentStage, job, triggerType), take is_any_of or is_none_of and comma-separated ids from business_customer_filter_options_get_v2 (buyerType takes consumer or organization), `none` for a customer with no value. createdAt takes on_or_after or on_or_before and an ISO date, or between and `from..to`, read in UTC. performance (the latest Discovery outcome) takes is_any_of or is_none_of and won, lost or `none`.","maxItems":20,"type":"array","items":{"type":"string","minLength":5,"maxLength":4000,"pattern":"^[A-Za-z]+(?:\\.band)?:[a-z_]+:.+$"}}},{"name":"filterMatch","in":"query","required":false,"description":"Whether a customer matches every condition (all, the default) or any one","schema":{"description":"Whether a customer matches every condition (all, the default) or any one","type":"string","enum":["all","any"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomerPoolSelectionsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/customer-model-facts":{"get":{"operationId":"business.customer-model-facts.list.v1","summary":"List customer model facts","description":"List customers as Point11's models read them, their model facts: each one's current version number and every attribute of the customer model under its key (name included; a category, and a band as <key>.band, by its label; Location as its country and region codes, town, postal code, street and point; Household as its counts; product.definition, what its business profile says it sells on the customer's Product; buyerType), an attribute its buyer type lacks left out. Pass customerIds for named customers, under the same businessProfileId, locationKey, lifecycleStatus, search, audienceNames and field filters business_customers_list_v3 takes, in id order, up to 100 a page (page with nextCursor).","tags":["business"],"x-cli-name":"business-customer-model-facts-list","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"default":20,"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024}},{"name":"customerIds","in":"query","required":false,"description":"Only these customers, under every other filter","schema":{"description":"Only these customers, under every other filter","minItems":1,"maxItems":1000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},{"name":"businessProfileId","in":"query","required":false,"description":"Only this business profile's customers; omit for every profile","schema":{"description":"Only this business profile's customers; omit for every profile","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"locationKey","in":"query","required":false,"description":"Only the customers generated for this store: a store profile's location key, as business_store_profile_summaries_get_v1 lists them under its businessProfileId","schema":{"description":"Only the customers generated for this store: a store profile's location key, as business_store_profile_summaries_get_v1 lists them under its businessProfileId","type":"string","minLength":1,"maxLength":500}},{"name":"lifecycleStatus","in":"query","required":false,"schema":{"default":"active","type":"string","enum":["active","archived","all"]}},{"name":"search","in":"query","required":false,"description":"Match the customer's name","schema":{"default":"","description":"Match the customer's name","type":"string","maxLength":200}},{"name":"audienceNames","in":"query","required":false,"description":"Source and label names, as business_customers_list_v3 takes them: only customers in any named source and in any named label","schema":{"default":[],"description":"Source and label names, as business_customers_list_v3 takes them: only customers in any named source and in any named label","maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":160}}},{"name":"filters","in":"query","required":false,"description":"Field conditions, each `<field>:<operator>:<value>`. Text fields (location, employer, trigger) take contains, does_not_contain, is or starts_with and the words. Number fields (age, householdIncome, companySize, annualRevenue) take gt, gte, lt, lte or eq and a number, or between and `min..max`. Classification fields, each band under its fact's key as <key>.band (gender, age.band, language, market, areaType, education, lifeStage, householdIncome.band, occupation, seniority, companySize.band, buyerType, audience, product, channel, buyerRole, intentStage, job, triggerType), take is_any_of or is_none_of and comma-separated ids from business_customer_filter_options_get_v2 (buyerType takes consumer or organization), `none` for a customer with no value. createdAt takes on_or_after or on_or_before and an ISO date, or between and `from..to`, read in UTC. performance (the latest Discovery outcome) takes is_any_of or is_none_of and won, lost or `none`.","schema":{"description":"Field conditions, each `<field>:<operator>:<value>`. Text fields (location, employer, trigger) take contains, does_not_contain, is or starts_with and the words. Number fields (age, householdIncome, companySize, annualRevenue) take gt, gte, lt, lte or eq and a number, or between and `min..max`. Classification fields, each band under its fact's key as <key>.band (gender, age.band, language, market, areaType, education, lifeStage, householdIncome.band, occupation, seniority, companySize.band, buyerType, audience, product, channel, buyerRole, intentStage, job, triggerType), take is_any_of or is_none_of and comma-separated ids from business_customer_filter_options_get_v2 (buyerType takes consumer or organization), `none` for a customer with no value. createdAt takes on_or_after or on_or_before and an ISO date, or between and `from..to`, read in UTC. performance (the latest Discovery outcome) takes is_any_of or is_none_of and won, lost or `none`.","maxItems":20,"type":"array","items":{"type":"string","minLength":5,"maxLength":4000,"pattern":"^[A-Za-z]+(?:\\.band)?:[a-z_]+:.+$"}}},{"name":"filterMatch","in":"query","required":false,"description":"Whether a customer matches every condition (all, the default) or any one","schema":{"description":"Whether a customer matches every condition (all, the default) or any one","type":"string","enum":["all","any"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomerModelFactsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/customers-v3/{id}":{"get":{"operationId":"business.customers.get.v3","summary":"Get customers (v3)","description":"Deprecated: use business.customers.get.v4 (business_customers_get_v4), which names no faviconLightUrl or faviconDarkUrl: a favicon is one image for both themes, faviconUrl. This version answers the same and names both, never sent. Get one customer by its id, customer key, or the id of the run that generated it: its current version as the customer model states it (persona: every attribute under its key, in the model's groups and order; each category as its id and label; Age, Household income and Company size with the band stored beside them; Employer with its source link; Household; Product; Buyer type, derived from the audience's declared type, with the attributes only the other buyer type has left out), its editable fields by the same keys with the options each category and band may take (a fixed list whole; an open category's profile options and the values members added for its business profile, marked memberAdded), its audiences and sources, any CRM field pins and open pin reviews by field, and its latest activity in Discovery, Experience, and Research.","deprecated":true,"tags":["business"],"x-cli-name":"business-customers-get-v3","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The customer's id or customer key, or the id of the run that generated it","schema":{"type":"string","minLength":1,"maxLength":200,"description":"The customer's id or customer key, or the id of the run that generated it"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomersGetV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/customers-v4/{id}":{"get":{"operationId":"business.customers.get.v4","summary":"Get customers (v4)","description":"Get one customer by its id, customer key, or the id of the run that generated it: its current version as the customer model states it (persona: every attribute under its key, in the model's groups and order; each category as its id and label; Age, Household income and Company size with the band stored beside them; Employer with its source link; Household; Product; Buyer type, derived from the audience's declared type, with the attributes only the other buyer type has left out), its editable fields by the same keys with the options each category and band may take (a fixed list whole; an open category's profile options and the values members added for its business profile, marked memberAdded), its audiences and sources, any CRM field pins and open pin reviews by field, and its latest activity in Discovery, Experience, and Research.","tags":["business"],"x-cli-name":"business-customers-get-v4","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The customer's id or customer key, or the id of the run that generated it","schema":{"type":"string","minLength":1,"maxLength":200,"description":"The customer's id or customer key, or the id of the run that generated it"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomersGetV4Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/customer-selections/{id}":{"get":{"operationId":"business.customer-selections.get.v1","summary":"Get customer selections","description":"Resolve which customer a customer page opens. Pass a customer's id, customer key, or the id of the run that generated it to select that customer, or \"default\" for the newest active customer of businessProfileId (a profile id or profile key), else its newest archived one, else the organization's newest active customer, else its newest archived one; an id that names no customer also yields that default. Returns the selected customer's id, customer key, and business profile (null when the organization has no customer), and every business profile that has customers, to switch between.","tags":["business"],"x-cli-name":"business-customer-selections-get","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"A customer's id or customer key, or the id of the run that generated it; \"default\" for the default customer","schema":{"type":"string","minLength":1,"maxLength":200,"description":"A customer's id or customer key, or the id of the run that generated it; \"default\" for the default customer"}},{"name":"businessProfileId","in":"query","required":false,"description":"The business profile (id or profile key) whose newest customer the default prefers","schema":{"description":"The business profile (id or profile key) whose newest customer the default prefers","type":"string","minLength":1,"maxLength":200}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomerSelectionsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/customers/update-v4":{"post":{"operationId":"business.customers.update.v4","summary":"Update customers (v4)","description":"Save a member's edits to one customer as its next version; expectedVersion is the version you read (STALE_WRITE if it moved). Fields use the customer model's keys, as business_customers_get_v4's editable fields: a category takes an option id from there or null (else INVALID_INPUT); an open category (occupation, audience, channel, market, buyer role, job, trigger type) may be words in newValues (that option, else a new one for the profile). Age, household income and company size take { value, band }; a changed value sets its band unless the edit does. A changed business employer clears company size and annual revenue unless set. The audience after the edit decides the buyer type: a value it lacks (a consumer's company size, an organization buyer's household) is INVALID_INPUT (CUSTOMER_VERSION_ATTRIBUTE_NOT_APPLICABLE, naming field and buyerType), and a buyer-type change clears such values. A place is geocoded with Mapbox (kept as written if not found). A CRM-connected customer's edited fields are pinned against CRM updates. The customer reruns once on the new version in each live campaign, at once or, while a conversation of theirs runs there, once the campaign can take it (an edit before then joins it, rerun.joinedRequestIds; one after reruns again), as the campaign's run for its current period: its scheduled run, not yet admitted, waits and does not run again; work admitted earlier keeps its version. Paused or held campaigns, one-time studies, Bursts, Pulse, Point11's own campaigns and products Billing would not rerun are skipped (rerun.skipped, Billing's sentence in message); the edit saves regardless.","tags":["business"],"x-cli-name":"business-customers-update-v4","x-point11-scope":"business:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomersUpdateV4Request"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomersUpdateV4Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/customers/archive":{"post":{"operationId":"business.customers.archive.v1","summary":"Archive customers","description":"Archive up to 100 customers: they leave every future campaign and stay listed under the archived filter, where business_customers_restore brings them back. Read business_customer_lifecycle_impacts_get first to see which campaigns they leave.","tags":["business"],"x-cli-name":"business-customers-archive","x-point11-scope":"business:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomersArchiveRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomersArchiveResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/customers/restore":{"post":{"operationId":"business.customers.restore.v1","summary":"Restore customers","description":"Restore up to 100 archived customers to the active pool; campaigns they left do not take them back on their own.","tags":["business"],"x-cli-name":"business-customers-restore","x-point11-scope":"business:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomersRestoreRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomersRestoreResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/customers/delete":{"post":{"operationId":"business.customers.delete.v1","summary":"Delete customers","description":"Permanently delete up to 100 customers, after the user confirms. Refused while any of them has active product work or a future campaign membership (archive those first); a CRM-connected customer is forgotten through its CRM contact instead.","tags":["business"],"x-cli-name":"business-customers-delete","x-point11-scope":"business:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}},{"name":"Point11-Confirm","in":"header","required":true,"description":"Explicit human confirmation of this operation's effect.","schema":{"type":"string","enum":["true"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomersDeleteRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomersDeleteResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/customers/generate":{"post":{"operationId":"business.customers.generate.v1","summary":"Generate customers","description":"Generate new customers for a business profile, included in the plan at no charge, from its current profile (source current) or a generation profile such as a forecast or CRM import (source artifact); optionally name a new audience or existing audiences to put them in. A member or an API key with business:write may start it; a key's run names no member. Returns the run; follow it with platform_runs_get_v2, then list the customers.","tags":["business"],"x-cli-name":"business-customers-generate","x-point11-scope":"business:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomersGenerateRequest"}}}},"responses":{"202":{"description":"Accepted: the durable run started. Follow it with `GET /api/v1/platform/runs-v2/{id}`.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomersGenerateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/customer-field-pins/delete-v2":{"post":{"operationId":"business.customer-field-pins.delete.v2","summary":"Delete customer field pins (v2)","description":"As the signed-in member, unpin fields of a CRM-connected customer so the next CRM update may write them again; the values stay as they are until then.","tags":["business"],"x-cli-name":"business-customer-field-pins-delete-v2","x-point11-scope":"business:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomerFieldPinsDeleteV2Request"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomerFieldPinsDeleteV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/customer-pin-reviews/resolve":{"post":{"operationId":"business.customer-pin-reviews.resolve.v1","summary":"Resolve customer pin reviews","description":"As the signed-in member, resolve a CRM change to a pinned field of a connected customer: keep_mine keeps the customer's value, use_crm saves the CRM value as a new customer version. Name the review's refreshId and the customer version you read.","tags":["business"],"x-cli-name":"business-customer-pin-reviews-resolve","x-point11-scope":"business:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomerPinReviewsResolveRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomerPinReviewsResolveResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/customer-lifecycle-impacts/{id}":{"get":{"operationId":"business.customer-lifecycle-impacts.get.v1","summary":"Get customer lifecycle impacts","description":"Preview what archiving, restoring, or deleting up to 100 customers would touch (pass id \"organization\"): per customer and in total, the active product work, future campaign memberships, and past campaign references each product holds, and why a delete would be refused.","tags":["business"],"x-cli-name":"business-customer-lifecycle-impacts-get","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","const":"organization"}},{"name":"customerIds","in":"query","required":true,"description":"The customers' ids (1–1000)","schema":{"minItems":1,"maxItems":1000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":"The customers' ids (1–1000)"}},{"name":"command","in":"query","required":true,"description":"The change to preview; only delete can be refused by the impact","schema":{"type":"string","enum":["archive","restore","delete"],"description":"The change to preview; only delete can be refused by the impact"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomerLifecycleImpactsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/customer-versions-v3":{"get":{"operationId":"business.customer-versions.list.v3","summary":"List customer versions (v3)","description":"List one customer's persona versions, newest first, each with who or what wrote it (a member's edit, a CRM update, or generation), the fields it changed (by the customer model's key, a band as <key>.band, a category by its label), and the pins taken, released or reviewed with it. A change to a field the model removed is left out. Page with nextCursor.","tags":["business"],"x-cli-name":"business-customer-versions-list-v3","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"customerId","in":"query","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"limit","in":"query","required":false,"schema":{"default":20,"type":"integer","minimum":1,"maximum":50}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomerVersionsListV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/customer-explorer-reports/{id}":{"get":{"operationId":"business.customer-explorer-reports.get.v1","summary":"Get customer explorer reports","description":"Get the customer overview for the organization or one business profile (pass id \"organization\"): how the active pool splits by segment, location, and audience, for the Customers overview.","tags":["business"],"x-cli-name":"business-customer-explorer-reports-get","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","const":"organization"}},{"name":"job_mix","in":"query","required":false,"description":"Only customers in these job_mix groups (their catalogIds)","schema":{"description":"Only customers in these job_mix groups (their catalogIds)","maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":200}}},{"name":"audience_mix","in":"query","required":false,"description":"Only customers in these audience_mix groups (their catalogIds)","schema":{"description":"Only customers in these audience_mix groups (their catalogIds)","maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":200}}},{"name":"channel_mix","in":"query","required":false,"description":"Only customers in these channel_mix groups (their catalogIds)","schema":{"description":"Only customers in these channel_mix groups (their catalogIds)","maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":200}}},{"name":"revenue_mix","in":"query","required":false,"description":"Only customers in these revenue_mix groups (their catalogIds)","schema":{"description":"Only customers in these revenue_mix groups (their catalogIds)","maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":200}}},{"name":"intent_stage_mix","in":"query","required":false,"description":"Only customers in these intent_stage_mix groups (their catalogIds)","schema":{"description":"Only customers in these intent_stage_mix groups (their catalogIds)","maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":200}}},{"name":"age_mix","in":"query","required":false,"description":"Only customers in these age_mix groups (their catalogIds)","schema":{"description":"Only customers in these age_mix groups (their catalogIds)","maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":200}}},{"name":"gender_mix","in":"query","required":false,"description":"Only customers in these gender_mix groups (their catalogIds)","schema":{"description":"Only customers in these gender_mix groups (their catalogIds)","maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":200}}},{"name":"education_mix","in":"query","required":false,"description":"Only customers in these education_mix groups (their catalogIds)","schema":{"description":"Only customers in these education_mix groups (their catalogIds)","maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":200}}},{"name":"household_income_mix","in":"query","required":false,"description":"Only customers in these household_income_mix groups (their catalogIds)","schema":{"description":"Only customers in these household_income_mix groups (their catalogIds)","maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":200}}},{"name":"urbanicity_mix","in":"query","required":false,"description":"Only customers in these urbanicity_mix groups (their catalogIds)","schema":{"description":"Only customers in these urbanicity_mix groups (their catalogIds)","maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":200}}},{"name":"regional_mix","in":"query","required":false,"description":"Only customers in these regional_mix groups (their catalogIds)","schema":{"description":"Only customers in these regional_mix groups (their catalogIds)","maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":200}}},{"name":"life_stage_mix","in":"query","required":false,"description":"Only customers in these life_stage_mix groups (their catalogIds)","schema":{"description":"Only customers in these life_stage_mix groups (their catalogIds)","maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":200}}},{"name":"language_mix","in":"query","required":false,"description":"Only customers in these language_mix groups (their catalogIds)","schema":{"description":"Only customers in these language_mix groups (their catalogIds)","maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":200}}},{"name":"occupation_mix","in":"query","required":false,"description":"Only customers in these occupation_mix groups (their catalogIds)","schema":{"description":"Only customers in these occupation_mix groups (their catalogIds)","maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":200}}},{"name":"company_size_mix","in":"query","required":false,"description":"Only customers in these company_size_mix groups (their catalogIds)","schema":{"description":"Only customers in these company_size_mix groups (their catalogIds)","maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":200}}},{"name":"buyer_role_mix","in":"query","required":false,"description":"Only customers in these buyer_role_mix groups (their catalogIds)","schema":{"description":"Only customers in these buyer_role_mix groups (their catalogIds)","maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":200}}},{"name":"country","in":"query","required":false,"description":"Only customers in this country (ISO 3166-1 alpha-2)","schema":{"description":"Only customers in this country (ISO 3166-1 alpha-2)","type":"string","pattern":"^[A-Z]{2}$"}},{"name":"region","in":"query","required":false,"description":"Only customers in this region (ISO 3166-2, for example US-CA)","schema":{"description":"Only customers in this region (ISO 3166-2, for example US-CA)","type":"string","pattern":"^[A-Z]{2}-[A-Z0-9]{1,8}$"}},{"name":"postalCodes","in":"query","required":false,"description":"false reads geography down to states and provinces, for a caller that draws no postal code: no postal node. Omit it, or pass true, for each US customer's postal code too.","schema":{"description":"false reads geography down to states and provinces, for a caller that draws no postal code: no postal node. Omit it, or pass true, for each US customer's postal code too.","type":"boolean"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomerExplorerReportsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/customer-conversations":{"get":{"operationId":"business.customer-conversations.list.v1","summary":"List customer conversations","description":"List one customer's Discovery AI conversations, newest first: each one's campaign, AI engine, and when it ran. Read one with business_customer_conversations_get_v2. The customer's Experience journeys are experience_customer_journeys_list_v2; their Research interviews are research_conversations_list_v2 with a customer segment.","tags":["business"],"x-cli-name":"business-customer-conversations-list","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"customerId","in":"query","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"limit","in":"query","required":false,"description":"Conversations come in pages of 25","schema":{"default":25,"description":"Conversations come in pages of 25","type":"number","const":25}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomerConversationsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/customer-conversations/{id}":{"get":{"operationId":"business.customer-conversations.get.v1","summary":"Get customer conversations","description":"Deprecated: use business.customer-conversations.get.v2 (business_customer_conversations_get_v2), which names no faviconLightUrl or faviconDarkUrl: a favicon is one image for both themes, faviconUrl. This version answers the same and names both, never sent. Get one of a customer's Discovery AI conversations by id: its transcript turns with cited sources and searches, and how each brand it mentioned scored.","deprecated":true,"tags":["business"],"x-cli-name":"business-customer-conversations-get","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The Discovery conversation's id","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The Discovery conversation's id"}},{"name":"customerId","in":"query","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomerConversationsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/customer-conversations-v2/{id}":{"get":{"operationId":"business.customer-conversations.get.v2","summary":"Get customer conversations (v2)","description":"Get one of a customer's Discovery AI conversations by id: its transcript turns with cited sources and searches, and how each brand it mentioned scored.","tags":["business"],"x-cli-name":"business-customer-conversations-get-v2","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The Discovery conversation's id","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The Discovery conversation's id"}},{"name":"customerId","in":"query","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomerConversationsGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/customer-audiences/create":{"post":{"operationId":"business.customer-audiences.create.v1","summary":"Create customer audiences","description":"Create a named customer audience, optionally adding customers to it at once; a name the organization already uses returns that audience (reused true). Campaigns can target an audience.","tags":["business"],"x-cli-name":"business-customer-audiences-create","x-point11-scope":"business:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomerAudiencesCreateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomerAudiencesCreateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/customer-audiences/update":{"post":{"operationId":"business.customer-audiences.update.v1","summary":"Update customer audiences","description":"Rename one of the organization's own customer audiences; audiences the system applies (sources, forecasts) cannot be renamed.","tags":["business"],"x-cli-name":"business-customer-audiences-update","x-point11-scope":"business:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomerAudiencesUpdateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomerAudiencesUpdateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/customer-audiences/delete":{"post":{"operationId":"business.customer-audiences.delete.v1","summary":"Delete customer audiences","description":"Delete one of the organization's own customer audiences; refused while a campaign targets it, and its customers stay in the pool.","tags":["business"],"x-cli-name":"business-customer-audiences-delete","x-point11-scope":"business:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomerAudiencesDeleteRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomerAudiencesDeleteResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/customer-audience-memberships/update":{"post":{"operationId":"business.customer-audience-memberships.update.v1","summary":"Update customer audience memberships","description":"Add customers to audiences and remove them from others in one change. A removal that changes which customers an active or paused campaign targets fails with CONFLICT naming those campaigns; repeat it with their ids in acknowledgedCampaignIds to confirm.","tags":["business"],"x-cli-name":"business-customer-audience-memberships-update","x-point11-scope":"business:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomerAudienceMembershipsUpdateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomerAudienceMembershipsUpdateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/manual-profile-options/{id}":{"get":{"operationId":"business.manual-profile-options.get.v1","summary":"Get manual profile options","description":"Deprecated: use business.manual-profile-options.get.v2 (business_manual_profile_options_get_v2), which also offers each need's trigger types (trigger_type_mix); this version leaves them out. Get what a Manual Profile of one business profile (id is its business profile id) may choose: each customer dimension and its values, pinned to the exact profile base a Manual Profile is built on.","deprecated":true,"tags":["business"],"x-cli-name":"business-manual-profile-options-get","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The business profile's id","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The business profile's id"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessManualProfileOptionsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/manual-profile-options-v2/{id}":{"get":{"operationId":"business.manual-profile-options.get.v2","summary":"Get manual profile options (v2)","description":"Get what a Manual Profile of one business profile (id is its business profile id) may choose: each customer dimension and its values (trigger types among them, which a Manual Profile sets under every need it keeps), pinned to the exact profile base a Manual Profile is built on.","tags":["business"],"x-cli-name":"business-manual-profile-options-get-v2","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The business profile's id","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The business profile's id"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessManualProfileOptionsGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/manual-profiles/create":{"post":{"operationId":"business.manual-profiles.create.v1","summary":"Create manual profiles","description":"Deprecated: use business.manual-profiles.create.v2 (business_manual_profiles_create_v2), whose card names no employer accounts; give customers who work at named accounts as rows to business_customers_generate (source rows). Create a reusable Manual Profile from a business profile and the dimension values you choose (from business_manual_profile_options_get_v2), or apply a ready-made audience by passing its card from business_customer_packs_list unchanged, after an acceptable-use screen; optionally generate customers from it in the same run, included in the plan at no charge. A member or an API key with business:write may start it. Returns the run; read the result with business_manual_profiles_get.","deprecated":true,"tags":["business"],"x-cli-name":"business-manual-profiles-create","x-point11-scope":"business:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessManualProfilesCreateRequest"}}}},"responses":{"202":{"description":"Accepted: the durable run started. Follow it with `GET /api/v1/platform/runs-v2/{id}`.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessManualProfilesCreateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/manual-profiles/create-v2":{"post":{"operationId":"business.manual-profiles.create.v2","summary":"Create manual profiles (v2)","description":"Create a reusable Manual Profile from a business profile and the dimension values you choose (from business_manual_profile_options_get_v2), or apply a ready-made audience by passing its card from business_customer_packs_list unchanged, after an acceptable-use screen; optionally generate customers from it in the same run, included in the plan at no charge. The card names no employer accounts: give customers who work at named accounts as rows to business_customers_generate (source rows). A member or an API key with business:write may start it. Returns the run; read the result with business_manual_profiles_get.","tags":["business"],"x-cli-name":"business-manual-profiles-create-v2","x-point11-scope":"business:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessManualProfilesCreateV2Request"}}}},"responses":{"202":{"description":"Accepted: the durable run started. Follow it with `GET /api/v1/platform/runs-v2/{id}`.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessManualProfilesCreateV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/manual-profiles/{id}":{"get":{"operationId":"business.manual-profiles.get.v1","summary":"Get manual profiles","description":"Get the Manual Profile a business_manual_profiles_create_v2 run made, by the run id: pending while it runs, then ready with its generation profile id and anything review could not support, or failed.","tags":["business"],"x-cli-name":"business-manual-profiles-get","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The business_manual_profiles_create_v2 runId","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The business_manual_profiles_create_v2 runId"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessManualProfilesGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/customer-packs":{"get":{"operationId":"business.customer-packs.list.v1","summary":"List customer packs","description":"List Point11's ready-made audiences for one business profile, by family (Google Ads' audience segment types: affinity, in-market, life events and demographics, then business buyers): each pack's key, revision, family, name, description and buyer type, and how a creative test with it starts (first impressions, or the buying situation it states); how many prewritten people it holds, which business_customer_packs_apply makes customers of the profile with no model call; who its people are as a Manual Profile card (version 3) for this profile, or null with unavailableReason when the profile has no audience of the pack's buyer type or no customer mix yet; and the audience of the pack's name when one exists, with how many of this profile's customers in it can take part in research (eligibleCount). The card is drawn from the profile's current mix, so read it again after the profile changes.","tags":["business"],"x-cli-name":"business-customer-packs-list","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"businessProfileId","in":"query","required":true,"description":"The business profile the packs are drawn for","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The business profile the packs are drawn for"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomerPacksListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/customer-packs/apply":{"post":{"operationId":"business.customer-packs.apply.v1","summary":"Apply customer packs","description":"Make the first count of a ready-made audience's people (a pack key from business_customer_packs_list; each pack holds 400) customers of one business profile, in the audience of the pack's name, with no model call and no charge. Point11 wrote these people in advance; each gets an audience of the pack's buyer type drawn from the profile's own at its weights, and no other category of the profile. Applying again adds only those missing (one a member deleted or archived is passed over for the next), so a retry is safe. Returns the audience to target, its customers from the pack in order, and how many this call added. A profile with no audience of the pack's buyer type, or no customer mix yet, answers 409.","tags":["business"],"x-cli-name":"business-customer-packs-apply","x-point11-scope":"business:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomerPacksApplyRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomerPacksApplyResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/customer-descriptions/create-v3":{"post":{"operationId":"business.customer-descriptions.create.v3","summary":"Create customer descriptions (v3)","description":"Describe the customers you want in plain text for one business profile (a member or an API key with business:write); Point11 reads it against the profile's customer mix (trigger types among it) and returns the review to confirm and, when it could interpret it, the Manual Profile card (version 3) to pass unchanged to business_manual_profiles_create_v2 (when it names employerAccounts, give those customers as rows to business_customers_generate, source rows, instead): its mixes, its customers' employers, and the group's given facts by the customer model's keys (a statement about the group, Location country and region codes, the household, a number such as annualRevenue, its labels). dropped names facts the card leaves out because its audiences' buyer type lacks them. A product the profile lacks may be named: products holds the Product mix with each new name, and the card omits its revenue mix until each is created with business_revenue_lines_create_v2 and set on the card by id. Anything it leaves unnamed comes from the Profile.","tags":["business"],"x-cli-name":"business-customer-descriptions-create-v3","x-point11-scope":"business:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomerDescriptionsCreateV3Request"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomerDescriptionsCreateV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/customer-descriptions/{id}":{"get":{"operationId":"business.customer-descriptions.get.v1","summary":"Get customer descriptions","description":"Get one customer description business_customer_descriptions_create_v3 read, by its descriptionId: the answer it gave, its outcome, review, unresolved phrases, the Manual Profile card (version 3) to pass to business_manual_profiles_create_v2 (its employerAccounts as rows to business_customers_generate), dropped facts and products, unchanged. A description saved in a retired format is refused (describe again).","tags":["business"],"x-cli-name":"business-customer-descriptions-get","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The business_customer_descriptions_create_v3 descriptionId","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The business_customer_descriptions_create_v3 descriptionId"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomerDescriptionsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/customer-edit-reviews/create-v4":{"post":{"operationId":"business.customer-edit-reviews.create.v4","summary":"Create customer edit reviews (v4)","description":"Deprecated: use business.customer-edit-reviews.create.v5 (business_customer_edit_reviews_create_v5), which reviews any number of customers as a durable run; this version reviews at most 20 in one call and answers when it is done. Propose each selected customer's new version from a bulk edit conversation (as business_customer_edit_reviews_create_v5 takes it, with at most 20 customers and no brief): returns, per customer, its name, the version it was written against, each changed field by the customer model's key (every one but name; a band as <key>.band, such as age.band) with its current and proposed value (a classification or band by its label, words that become a new value of the business marked newValue, a place, or a household's adults, children and pets), whether the proposal is exactly what the member said or the nearest reading of their words (fit, quoting them in said), the fields a rule sets from a changed fact (follows), any labels to add the customer to, and its product change when the conversation names its product: one of its business profile's products (kind product, by revenue line id, among its option set's products), or a product the business does not have yet (kind new_product, with a name and what it sells), which business_revenue_lines_create_v2 creates before the apply names it; its buyer type and every field a bulk edit sets that applies to it (fields, each with its current value), which the apply may set beside the proposal; plus each customer's classification, band and product options. Writes no customer; pass the review's runId to business_customer_edit_reviews_apply_v4 to save it.","deprecated":true,"tags":["business"],"x-cli-name":"business-customer-edit-reviews-create-v4","x-point11-scope":"business:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomerEditReviewsCreateV4Request"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomerEditReviewsCreateV4Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/customer-edit-reviews/create-v5":{"post":{"operationId":"business.customer-edit-reviews.create.v5","summary":"Create customer edit reviews (v5)","description":"Start a review of a bulk edit conversation over any number of selected customers: pass the customers, the conversation so far (ending with the member's message), every field it describes with a summary (by the customer model's own key, as business_customers_get_v4's attributes name them, every one but name, and the labels as labels), the files attached to it (business profile attachments, by id) and optionally a brief, the decided reading of the conversation, which the review applies as decided; the selection, in its order, is split into batches of up to 20 customers, each rewritten by its own call, after the same acceptable-use screen. Returns the run, how many customers it reviews and how many batches; follow it with business_customer_edit_reviews_get_v2, which shows each batch's customers as it lands. A batch that fails leaves its customers without a proposal (review them again); the run fails only when no batch was accepted. Writes no customer; pass the runId to business_customer_edit_reviews_apply_v4, up to 20 customers per call.","tags":["business"],"x-cli-name":"business-customer-edit-reviews-create-v5","x-point11-scope":"business:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomerEditReviewsCreateV5Request"}}}},"responses":{"202":{"description":"Accepted: the durable run started. Follow it with `GET /api/v1/platform/runs-v2/{id}`.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomerEditReviewsCreateV5Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/customer-edit-reviews/{id}":{"get":{"operationId":"business.customer-edit-reviews.get.v1","summary":"Get customer edit reviews","description":"Deprecated: use business.customer-edit-reviews.get.v2 (business_customer_edit_reviews_get_v2), which reads a review whose conversation holds a message over 8,000 characters. This version gets a bulk edit review a business_customer_edit_reviews_create_v5 run is writing, by its runId: running while any batch is still being written, then succeeded (at least one batch accepted) or failed. Returns each batch's customers and state (pending, accepted, or failed), every accepted batch's customers with their proposed changes, buyer type, fields and labels, and their option sets, and the request the review was started with (its customers in order, conversation, readings, brief and files), which business_customer_edit_reviews_create_v5 takes again, its customerIds narrowed, to review again. A review with a message over 8,000 characters is refused (409 CUSTOMER_EDIT_REVIEW_VERSION_UNSUPPORTED).","deprecated":true,"tags":["business"],"x-cli-name":"business-customer-edit-reviews-get","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The business_customer_edit_reviews_create_v5 runId","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The business_customer_edit_reviews_create_v5 runId"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomerEditReviewsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/customer-edit-reviews-v2/{id}":{"get":{"operationId":"business.customer-edit-reviews.get.v2","summary":"Get customer edit reviews (v2)","description":"Get a bulk edit review a business_customer_edit_reviews_create_v5 run is writing, by its runId: running while any batch is still being written, then succeeded (at least one batch accepted) or failed. Returns each batch's customers and state (pending, accepted, or failed), every accepted batch's customers with their proposed changes, buyer type, fields and labels, and their option sets, and the request the review was started with (its customers in order, conversation, readings, brief and files), which business_customer_edit_reviews_create_v5 takes again, its customerIds narrowed, to review again.","tags":["business"],"x-cli-name":"business-customer-edit-reviews-get-v2","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The business_customer_edit_reviews_create_v5 runId","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The business_customer_edit_reviews_create_v5 runId"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomerEditReviewsGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/customer-edit-reviews/apply-v4":{"post":{"operationId":"business.customer-edit-reviews.apply.v4","summary":"Apply customer edit reviews (v4)","description":"Save a bulk edit review as approved, up to 20 customers per call (apply more in parts, each standing alone), in one transaction: each named customer gets one version holding exactly the reviewed changes and the member's overrides (keyed as business_customers_update_v4 takes them, name excepted; the household as counts) and joins its labels, missing ones created. The review is a business_customer_edit_reviews_create_v5 run or one its version 4 started. Edits follow business_customers_update_v4's rules, each customer's outcome naming the fields they set; a value its buyer type lacks is INVALID_INPUT (CUSTOMER_VERSION_ATTRIBUTE_NOT_APPLICABLE, naming the customer): remove it, apply again. STALE_WRITE saves nothing when a customer or option changed since (review again) or the review predates the customer model (review_before_customer_model: propose again). Each new version reruns its customer as business_customers_update_v4 describes; labels alone make no version.","tags":["business"],"x-cli-name":"business-customer-edit-reviews-apply-v4","x-point11-scope":"business:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomerEditReviewsApplyV4Request"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomerEditReviewsApplyV4Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/crm-seed-options/{id}":{"get":{"operationId":"business.crm-seed-options.get.v1","summary":"Get crm seed options","description":"Get what customer generation from a CRM import may choose (id is the import's generation profile id): each segment's rows and how far earlier runs reached them, and the profile's buyer roles. Null options when the generation profile is no CRM import with rows; a generation profile that is not businessProfileId's is not found.","tags":["business"],"x-cli-name":"business-crm-seed-options-get","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The CRM import's generation profile id","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The CRM import's generation profile id"}},{"name":"businessProfileId","in":"query","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmSeedOptionsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/customer-generation-sources/{id}":{"get":{"operationId":"business.customer-generation-sources.get.v1","summary":"Get customer generation sources","description":"Get what customers can be generated from for up to 100 business profiles, or for every profile with finished research when businessProfileIds is omitted (latest research first, as business_profiles_list lists them; pass id \"organization\"): for each profile with finished research, its route key, display name and normalized URL, the language its customers speak, its current profile's generation profile (null until one is prepared), and its current forecast with that forecast's generation profile, the generationProfileId business_customers_generate takes for a forecast source. A profile without finished research, or not the organization's, is left out.","tags":["business"],"x-cli-name":"business-customer-generation-sources-get","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","const":"organization"}},{"name":"businessProfileIds","in":"query","required":false,"description":"These profiles' sources; omit for every profile with finished research, latest research first, up to 1000","schema":{"description":"These profiles' sources; omit for every profile with finished research, latest research first, up to 1000","minItems":1,"maxItems":100,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomerGenerationSourcesGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/customer-filter-options-v2/{id}":{"get":{"operationId":"business.customer-filter-options.get.v2","summary":"Get customer filter options (v2)","description":"Get the values each classification field can be filtered to (pass id \"organization\" and up to 25 fields by the customer model's keys, such as intentStage, language, product, buyerType or age.band), among the customers business_customers_list_v3 lists with the same businessProfileId, locationKey, lifecycleStatus, search, audienceNames and filters: each value's label, the ids to pass in that list's filters (one label can name ids of several profiles), and how many customers hold it, counted under every filter but that field's own, with how many customers hold no value.","tags":["business"],"x-cli-name":"business-customer-filter-options-get-v2","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","const":"organization"}},{"name":"fields","in":"query","required":true,"description":"The classification fields whose values to list.","schema":{"minItems":1,"maxItems":25,"type":"array","items":{"type":"string","enum":["performance","gender","age.band","language","market","areaType","education","lifeStage","householdIncome.band","occupation","seniority","companySize.band","buyerType","audience","product","channel","buyerRole","intentStage","job","triggerType"]},"description":"The classification fields whose values to list."}},{"name":"businessProfileId","in":"query","required":false,"description":"Only this business profile's customers; omit for every profile","schema":{"description":"Only this business profile's customers; omit for every profile","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"locationKey","in":"query","required":false,"description":"Only the customers generated for this store: a store profile's location key, as business_store_profile_summaries_get_v1 lists them under its businessProfileId","schema":{"description":"Only the customers generated for this store: a store profile's location key, as business_store_profile_summaries_get_v1 lists them under its businessProfileId","type":"string","minLength":1,"maxLength":500}},{"name":"lifecycleStatus","in":"query","required":false,"schema":{"default":"active","type":"string","enum":["active","archived","all"]}},{"name":"search","in":"query","required":false,"description":"Match the customer's name","schema":{"default":"","description":"Match the customer's name","type":"string","maxLength":200}},{"name":"audienceNames","in":"query","required":false,"description":"Source and label names: only customers in any named source and in any named label","schema":{"default":[],"description":"Source and label names: only customers in any named source and in any named label","maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":160}}},{"name":"filters","in":"query","required":false,"description":"Field conditions, each `<field>:<operator>:<value>`. Text fields (location, employer, trigger) take contains, does_not_contain, is or starts_with and the words. Number fields (age, householdIncome, companySize, annualRevenue) take gt, gte, lt, lte or eq and a number, or between and `min..max`. Classification fields, each band under its fact's key as <key>.band (gender, age.band, language, market, areaType, education, lifeStage, householdIncome.band, occupation, seniority, companySize.band, buyerType, audience, product, channel, buyerRole, intentStage, job, triggerType), take is_any_of or is_none_of and comma-separated ids from business_customer_filter_options_get_v2 (buyerType takes consumer or organization), `none` for a customer with no value. createdAt takes on_or_after or on_or_before and an ISO date, or between and `from..to`, read in UTC. performance (the latest Discovery outcome) takes is_any_of or is_none_of and won, lost or `none`.","schema":{"description":"Field conditions, each `<field>:<operator>:<value>`. Text fields (location, employer, trigger) take contains, does_not_contain, is or starts_with and the words. Number fields (age, householdIncome, companySize, annualRevenue) take gt, gte, lt, lte or eq and a number, or between and `min..max`. Classification fields, each band under its fact's key as <key>.band (gender, age.band, language, market, areaType, education, lifeStage, householdIncome.band, occupation, seniority, companySize.band, buyerType, audience, product, channel, buyerRole, intentStage, job, triggerType), take is_any_of or is_none_of and comma-separated ids from business_customer_filter_options_get_v2 (buyerType takes consumer or organization), `none` for a customer with no value. createdAt takes on_or_after or on_or_before and an ISO date, or between and `from..to`, read in UTC. performance (the latest Discovery outcome) takes is_any_of or is_none_of and won, lost or `none`.","maxItems":20,"type":"array","items":{"type":"string","minLength":5,"maxLength":4000,"pattern":"^[A-Za-z]+(?:\\.band)?:[a-z_]+:.+$"}}},{"name":"filterMatch","in":"query","required":false,"description":"Whether a customer matches every condition (all, the default) or any one","schema":{"description":"Whether a customer matches every condition (all, the default) or any one","type":"string","enum":["all","any"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomerFilterOptionsGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/customer-interviews/start":{"post":{"operationId":"business.customer-interviews.start.v1","summary":"Start customer interviews","description":"Start, or resume, the signed-in member's interview with one customer's digital twin: returns the chat conversation and its messages so far. Needs an active generated or CRM-connected customer and an operator-enabled interview agent.","tags":["business"],"x-cli-name":"business-customer-interviews-start","x-point11-scope":"business:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomerInterviewsStartRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCustomerInterviewsStartResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/profile-rows":{"get":{"operationId":"business.profile-rows.list.v1","summary":"List profile rows","description":"List the rows of the organization's Profiles table: each brand business profile (active by default, or archived) with its customer (its stores' included), campaign, and version counts and its latest generation state, plus any first generation still running or failed that has no profile yet. A store's place profile is no row of its own: list a brand's stores with business_store_profile_summaries_get. Filter by search, sort, and page with nextCursor.","tags":["business"],"x-cli-name":"business-profile-rows-list","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"lifecycleStatus","in":"query","required":false,"schema":{"default":"active","type":"string","enum":["active","archived"]}},{"name":"search","in":"query","required":false,"description":"Match the profile's name or website","schema":{"default":"","description":"Match the profile's name or website","type":"string","maxLength":500}},{"name":"sort","in":"query","required":false,"description":"Sort column; omit for running and failed generations first, then newest","schema":{"description":"Sort column; omit for running and failed generations first, then newest","type":"string","enum":["id","url","generationStatus","customerCount","campaignCount","updatedAt"]}},{"name":"direction","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessProfileRowsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/profiles/{id}":{"get":{"operationId":"business.profiles.get.v1","summary":"Get profiles","description":"Deprecated: use business.profiles.get.v2 (business_profiles_get_v2), which answers each competitor in the research's order with null for a value the research left empty; this version fills an empty intensity by its label or rank and an empty trend by its direction, rounds and caps both, draws a three-point trend from them, sorts competitors by that intensity and keeps the first seven, shortens a note and overlap to nine words and answers an empty one as \"—\", and keeps three battlegrounds that have a note, naming them from competitors' overlaps and writing template prose when the research named none. Get one business profile by its id or profile key: its lifecycle and generation state, what it allows next, and its researched content as the dashboard shows it (facts, revenue, audiences, channels, locations, competitors, about, forecasts). Name a tab to read only that section beside the heading; detail is null until the first generation lands.","deprecated":true,"tags":["business"],"x-cli-name":"business-profiles-get","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The profile's id or profile key","schema":{"type":"string","minLength":1,"maxLength":200,"description":"The profile's id or profile key"}},{"name":"tab","in":"query","required":false,"description":"Read only this tab's sections beside the heading; omit for every section","schema":{"type":"string","enum":["revenue","audiences","channels","locations","competitors","forecasts","about"],"description":"Read only this tab's sections beside the heading; omit for every section"}},{"name":"forecastKey","in":"query","required":false,"description":"Render this forecast of the profile instead of its current one","schema":{"description":"Render this forecast of the profile instead of its current one","type":"string","minLength":1,"maxLength":200}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessProfilesGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/profiles/check":{"post":{"operationId":"business.profiles.check.v1","summary":"Check profiles","description":"Review a described business profile before generating it, as the signed-in member: every attached upload must be ready, and the description and the files' names are screened for acceptable use (a denial is POLICY_DENIED with the reason to show). Then one included (unbilled) web search matches the description: `match.reading` is what the words themselves say about the subject (name, entity type, affiliation, role, location, website; null where unsaid) and `match.candidates` the public matches it found, best first, none when it found none. Returns the files generate will read and the match. Call business_profiles_generate with the same description, attachmentIds and Idempotency-Key, and subjectMatch {id, candidateIndex} for the candidate the member confirmed (null for none), to reuse this screen.","tags":["business"],"x-cli-name":"business-profiles-check","x-point11-scope":"business:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessProfilesCheckRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessProfilesCheckResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/profiles-v2/{id}":{"get":{"operationId":"business.profiles.get.v2","summary":"Get profiles (v2)","description":"Get one business profile by its id or profile key: its lifecycle and generation state, what it allows next, and its researched content as the dashboard shows it (facts, revenue, audiences, channels, locations, competitors, about, forecasts). Competitors keep the research's order, and a value the research left empty is null. Name a tab to read only that section beside the heading; detail is null until the first generation lands. A store's place profile answers like any profile, with its store (its brand's profile key and its location key) for business_store_profiles_get_v2.","tags":["business"],"x-cli-name":"business-profiles-get-v2","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The profile's id or profile key","schema":{"type":"string","minLength":1,"maxLength":200,"description":"The profile's id or profile key"}},{"name":"tab","in":"query","required":false,"description":"Read only this tab's sections beside the heading; omit for every section","schema":{"type":"string","enum":["revenue","audiences","channels","locations","competitors","forecasts","about"],"description":"Read only this tab's sections beside the heading; omit for every section"}},{"name":"forecastKey","in":"query","required":false,"description":"Render this forecast of the profile instead of its current one","schema":{"description":"Render this forecast of the profile instead of its current one","type":"string","minLength":1,"maxLength":200}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessProfilesGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/profiles/generate":{"post":{"operationId":"business.profiles.generate.v1","summary":"Generate profiles","description":"Research a new business profile, as a member or an API key with business:write, included in the plan at no charge, from one source: a website `url`, or a `description` of a subject with no website to start from (a person, practice, product or offering), or a `place`: a store of a brand business profile that has no place profile of its own yet (business_store_profiles_get_v2 answers its placeProfileId null), researched at the place its earlier research recorded, under the brand's current version, owing no forecast. A description takes optional attachmentIds of ready uploads that the opening research reads (a member's own; a key naming them is refused with user_required), and optionally the subjectMatch the member confirmed from business_profiles_check, which every research step reads with the words. A description and its files' names are screened for acceptable use first (business_profiles_check runs that screen without starting anything), and every refresh researches the same description and files. Returns the run; follow it with platform_runs_get_v2, then read it with business_profile_rows_list, or a store's with business_store_profiles_get_v2. A URL or store that already has a profile is refused with ALREADY_EXISTS: refresh that profile instead.","tags":["business"],"x-cli-name":"business-profiles-generate","x-point11-scope":"business:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessProfilesGenerateRequest"}}}},"responses":{"202":{"description":"Accepted: the durable run started. Follow it with `GET /api/v1/platform/runs-v2/{id}`.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessProfilesGenerateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/profiles/refresh":{"post":{"operationId":"business.profiles.refresh.v1","summary":"Refresh profiles","description":"Re-research an active business profile as the signed-in member, included in the plan at no charge; the result lands as the profile's next version. A store's place profile (business_store_profiles_get_v2's placeProfileId) re-researches its store at the place it froze, under its brand's current version, owing no forecast. Returns the run; follow it with platform_runs_get_v2.","tags":["business"],"x-cli-name":"business-profiles-refresh","x-point11-scope":"business:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessProfilesRefreshRequest"}}}},"responses":{"202":{"description":"Accepted: the durable run started. Follow it with `GET /api/v1/platform/runs-v2/{id}`.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessProfilesRefreshResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/profiles/update":{"post":{"operationId":"business.profiles.update.v1","summary":"Update profiles","description":"Save a member's edits to an active business profile as its next version: pass the values of business_profile_edit_sources_get with your changes, and its versionId and expectedName as read. If the profile moved since, this fails with STALE_WRITE and you read it again. Saving runs no research; the next generation reviews the edit.","tags":["business"],"x-cli-name":"business-profiles-update","x-point11-scope":"business:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessProfilesUpdateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessProfilesUpdateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/profiles/archive":{"post":{"operationId":"business.profiles.archive.v1","summary":"Archive profiles","description":"Archive up to 100 active business profiles: they leave active views and start no new work, and stay listed under the archived filter, where business_profiles_restore brings them back. A business's store profiles follow it, and a store profile on its own is refused (PLACE_PROFILE_FOLLOWS_BRAND). Refused while a profile has generation work running.","tags":["business"],"x-cli-name":"business-profiles-archive","x-point11-scope":"business:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessProfilesArchiveRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessProfilesArchiveResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/profiles/restore":{"post":{"operationId":"business.profiles.restore.v1","summary":"Restore profiles","description":"Restore up to 100 archived business profiles to the active list, with their store profiles. A store profile on its own is refused (PLACE_PROFILE_FOLLOWS_BRAND).","tags":["business"],"x-cli-name":"business-profiles-restore","x-point11-scope":"business:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessProfilesRestoreRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessProfilesRestoreResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/profiles/delete":{"post":{"operationId":"business.profiles.delete.v1","summary":"Delete profiles","description":"Permanently delete one business profile, after the user confirms: pass the impactHash business_profile_lifecycle_impacts_get answered. Its store profiles are deleted with it, and a store profile on its own is refused (PLACE_PROFILE_FOLLOWS_BRAND). Refused while its work runs or its campaigns block it, and with STALE_WRITE when what it touches changed since that read.","tags":["business"],"x-cli-name":"business-profiles-delete","x-point11-scope":"business:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}},{"name":"Point11-Confirm","in":"header","required":true,"description":"Explicit human confirmation of this operation's effect.","schema":{"type":"string","enum":["true"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessProfilesDeleteRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessProfilesDeleteResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/profile-lifecycle-impacts/{id}":{"get":{"operationId":"business.profile-lifecycle-impacts.get.v1","summary":"Get profile lifecycle impacts","description":"Preview what archiving, restoring, or deleting one business profile would touch: its campaigns per product and status, customers, versions, forecasts, and running work, why the change would be refused, and the impactHash business_profiles_delete takes.","tags":["business"],"x-cli-name":"business-profile-lifecycle-impacts-get","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The profile's id","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The profile's id"}},{"name":"action","in":"query","required":false,"description":"The change to preview","schema":{"default":"delete","description":"The change to preview","type":"string","enum":["archive","restore","delete"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessProfileLifecycleImpactsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/profile-edit-sources/{id}":{"get":{"operationId":"business.profile-edit-sources.get.v1","summary":"Get profile edit sources","description":"Get the editable source of an active business profile (id is its profile id): every field a member may change, with its type, label, and limits, and the current values to change and pass to business_profiles_update with this versionId and expectedName.","tags":["business"],"x-cli-name":"business-profile-edit-sources-get","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The profile's id","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The profile's id"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessProfileEditSourcesGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/profile-places/search":{"get":{"operationId":"business.profile-places.search.v1","summary":"Search profile places","description":"Search the location catalog a business profile's markets are drawn from, by name (at least two characters), for places to include in a market's location selection when editing the profile. Pass the profile's current versionId from business_profile_edit_sources_get.","tags":["business"],"x-cli-name":"business-profile-places-search","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"profileId","in":"query","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"versionId","in":"query","required":true,"description":"The profile's current version, as its edit source answered","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The profile's current version, as its edit source answered"}},{"name":"query","in":"query","required":true,"description":"A place name","schema":{"type":"string","minLength":2,"maxLength":120,"description":"A place name"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessProfilePlacesSearchResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/forecasts/{id}":{"get":{"operationId":"business.forecasts.get.v1","summary":"Get forecasts","description":"Get one forecast by its id or forecast key: the business profile it forecasts, whether it is that profile's current forecast, and its demand trends. Read it inside its profile with business_profiles_get_v2, tab forecasts and this forecastKey.","tags":["business"],"x-cli-name":"business-forecasts-get","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The forecast's id or forecast key","schema":{"type":"string","minLength":1,"maxLength":200,"description":"The forecast's id or forecast key"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessForecastsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/store-profiles/{id}":{"get":{"operationId":"business.store-profiles.get.v1","summary":"Get store profiles","description":"Deprecated: use business.store-profiles.get.v2 (business_store_profiles_get_v2), which answers each competitor in the research's order with null for a value the research left empty; this version fills an empty intensity by its label or rank and an empty trend by its direction, rounds and caps both, draws a three-point trend from them, sorts competitors by that intensity and keeps the first seven, shortens a note and overlap to nine words and answers an empty one as \"—\", and keeps three battlegrounds that have a note, naming them from competitors' overlaps and writing template prose when the research named none. Get one store's profile by its location key (id) under a brand business profile: the store's own researched content, read-only, and its place among the brand's stores. A physical-locations campaign generates one per verified premises; list them in the brand's business_profiles_get_v2 locations tab.","deprecated":true,"tags":["business"],"x-cli-name":"business-store-profiles-get","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The store's location key","schema":{"type":"string","minLength":1,"maxLength":500,"description":"The store's location key"}},{"name":"profileKey","in":"query","required":true,"description":"The brand business profile's id or profile key, or the store's own place profile's","schema":{"type":"string","minLength":1,"maxLength":200,"description":"The brand business profile's id or profile key, or the store's own place profile's"}},{"name":"tab","in":"query","required":false,"schema":{"type":"string","enum":["revenue","audiences","channels","locations","competitors","about"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessStoreProfilesGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/store-profiles-v2/{id}":{"get":{"operationId":"business.store-profiles.get.v2","summary":"Get store profiles (v2)","description":"Get one store's profile by its location key (id) under a brand business profile (profileKey: the brand's id or profile key, or the store's own place profile's): the store's own researched content and its place among the brand's stores. A store is a place profile of its own (placeProfileId), whose newest version this reads and which business_profiles_refresh re-researches; a store known only by research from before stores were profiles of their own answers that research, read-only, with placeProfileId null, and business_profiles_generate's place gives it a profile. Competitors keep the research's order, and a value the research left empty is null. A physical-locations campaign's setup researches one per verified premises; list them in the brand's business_profiles_get_v2 locations tab.","tags":["business"],"x-cli-name":"business-store-profiles-get-v2","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The store's location key","schema":{"type":"string","minLength":1,"maxLength":500,"description":"The store's location key"}},{"name":"profileKey","in":"query","required":true,"description":"The brand business profile's id or profile key, or the store's own place profile's","schema":{"type":"string","minLength":1,"maxLength":200,"description":"The brand business profile's id or profile key, or the store's own place profile's"}},{"name":"tab","in":"query","required":false,"schema":{"type":"string","enum":["revenue","audiences","channels","locations","competitors","about"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessStoreProfilesGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/store-profile-summaries/{id}":{"get":{"operationId":"business.store-profile-summaries.get.v1","summary":"Get store profile summaries","description":"List the stores of the organization's brand business profiles, archived ones included (pass \"organization\" as the id), or of one brand business profile (businessProfileId): each store's brand business profile, its location key (the id business_store_profiles_get_v2 takes, and the locationKey business_customers_list_v3 narrows to), its label (its street, else its locality), its locality (\"City, Region\", null when unknown), and how many active customers were generated for it, each brand's stores in the order its locations tab lists them. A physical-locations campaign's setup researches one per verified premises; a business profile with none lists no stores.","tags":["business"],"x-cli-name":"business-store-profile-summaries-get","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","const":"organization"}},{"name":"businessProfileId","in":"query","required":false,"description":"Only this business profile's stores; omit for every business profile","schema":{"description":"Only this business profile's stores; omit for every business profile","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessStoreProfileSummariesGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/profile-attachments/reserve-upload":{"post":{"operationId":"business.profile-attachments.reserve-upload.v1","summary":"Reserve upload profile attachments","description":"Reserve a file to attach to a described business profile's description, declaring its name, media type, size and SHA-256: a PNG, JPEG, WebP or PDF up to 4 MiB, or a plain text, Markdown or CSV file up to 256 KB. Returns the attachment and one presigned upload: send the file as the body of exactly that request before it expires, then call business_profile_attachments_complete_upload. A profile takes up to 10 files, 8 MiB together. Attachments record the member who uploaded them, so an API key cannot reserve one.","tags":["business"],"x-cli-name":"business-profile-attachments-reserve-upload","x-point11-scope":"business:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessProfileAttachmentsReserveUploadRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessProfileAttachmentsReserveUploadResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/profile-attachments/complete-upload":{"post":{"operationId":"business.profile-attachments.complete-upload.v1","summary":"Complete upload profile attachments","description":"Finish a profile attachment after its upload: the stored file is read back, must match the reserved size and SHA-256, and its bytes must prove its declared type. Pass the etag the upload answered, or omit it to recover from the store. Returns the attachment, ready to name in business_profiles_generate's attachmentIds; retrying is safe.","tags":["business"],"x-cli-name":"business-profile-attachments-complete-upload","x-point11-scope":"business:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessProfileAttachmentsCompleteUploadRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessProfileAttachmentsCompleteUploadResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/campaign-customer-pools/{id}":{"get":{"operationId":"business.campaign-customer-pools.get.v1","summary":"Get campaign customer pools","description":"Deprecated: use business.campaign-customer-pools.get.v2 (business_campaign_customer_pools_get_v2), which takes no includeStoreCustomers: every pool holds the profile's store customers beside its own. This version accepts includeStoreCustomers and ignores it. Read which of a business profile's customers a new campaign can draw from (`id` \"organization\"): name the profile by businessProfileId, or pass url to find the active profile for that website. Answers the profile, whether it has a current forecast, how many customers can join, and each audience and source with its count; a profile that cannot launch campaigns answers no profile.","deprecated":true,"tags":["business"],"x-cli-name":"business-campaign-customer-pools-get","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The literal \"organization\".","schema":{"type":"string","const":"organization","description":"The literal \"organization\"."}},{"name":"businessProfileId","in":"query","required":false,"description":"The business profile.","schema":{"description":"The business profile.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"url","in":"query","required":false,"description":"Without businessProfileId: the website whose active profile to read.","schema":{"description":"Without businessProfileId: the website whose active profile to read.","type":"string","maxLength":2048}},{"name":"includeStoreCustomers","in":"query","required":false,"description":"Ignored: every pool holds the profile's store customers beside its own.","schema":{"default":false,"description":"Ignored: every pool holds the profile's store customers beside its own.","type":"boolean"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCampaignCustomerPoolsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/campaign-customer-pools-v2/{id}":{"get":{"operationId":"business.campaign-customer-pools.get.v2","summary":"Get campaign customer pools (v2)","description":"Read which of a business profile's customers a new campaign can draw from (`id` \"organization\"), its stores' customers included: name the profile by businessProfileId, or pass url to find the active profile for that website. Answers the profile, whether it has a current forecast, how many customers can join, and each audience and source with its count; a profile that cannot launch campaigns answers no profile.","tags":["business"],"x-cli-name":"business-campaign-customer-pools-get-v2","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The literal \"organization\".","schema":{"type":"string","const":"organization","description":"The literal \"organization\"."}},{"name":"businessProfileId","in":"query","required":false,"description":"The business profile.","schema":{"description":"The business profile.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"url","in":"query","required":false,"description":"Without businessProfileId: the website whose active profile to read.","schema":{"description":"Without businessProfileId: the website whose active profile to read.","type":"string","maxLength":2048}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCampaignCustomerPoolsGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/campaign-pool-customers-v2":{"get":{"operationId":"business.campaign-pool-customers.list.v2","summary":"List campaign pool customers (v2)","description":"Deprecated: use business.campaign-pool-customers.list.v4 (business_campaign_pool_customers_list_v4), which names no faviconLightUrl or faviconDarkUrl (a favicon is one image for both themes, faviconUrl) and takes no includeStoreCustomers: every pool holds the profile's store customers beside its own. This version answers the same and names both, never sent, and accepts includeStoreCustomers and ignores it. Page through the customers a new campaign on a business profile can pick, searched by name or job title and narrowed to audiences: each with its table attributes under the customer model's keys (a category, band, Product and Buyer type as id and label), its audiences, place, and why it cannot join when includeIneligible lists those too. customerIds pages only those customers instead, each without a reason. selectedAudienceIds also answers every customer in those audiences, across every page. Page with nextCursor at the same limit.","deprecated":true,"tags":["business"],"x-cli-name":"business-campaign-pool-customers-list-v2","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of customers to return (1–100)","schema":{"default":100,"description":"Number of customers to return (1–100)","type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"businessProfileId","in":"query","required":true,"description":"The business profile.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The business profile."}},{"name":"search","in":"query","required":false,"description":"Words in a name or job title.","schema":{"description":"Words in a name or job title.","type":"string","maxLength":200}},{"name":"audienceIds","in":"query","required":false,"description":"Narrow to these audiences.","schema":{"description":"Narrow to these audiences.","minItems":1,"maxItems":50,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},{"name":"selectedAudienceIds","in":"query","required":false,"description":"Also answer every customer in these audiences as selectedCustomerIds.","schema":{"description":"Also answer every customer in these audiences as selectedCustomerIds.","minItems":1,"maxItems":50,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},{"name":"customerIds","in":"query","required":false,"description":"Page only these customers (a campaign's hand-picked ones); they name no cohort, so each is listed without a reason.","schema":{"description":"Page only these customers (a campaign's hand-picked ones); they name no cohort, so each is listed without a reason.","minItems":1,"maxItems":1000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},{"name":"includeIneligible","in":"query","required":false,"description":"Also list the customers the pick cannot take, after the rest.","schema":{"default":false,"description":"Also list the customers the pick cannot take, after the rest.","type":"boolean"}},{"name":"filters","in":"query","required":false,"description":"Field conditions, each `<field>:<operator>:<value>`. Text fields (location, employer, trigger) take contains, does_not_contain, is or starts_with and the words. Number fields (age, householdIncome, companySize, annualRevenue) take gt, gte, lt, lte or eq and a number, or between and `min..max`. Classification fields, each band under its fact's key as <key>.band (gender, age.band, language, market, areaType, education, lifeStage, householdIncome.band, occupation, seniority, companySize.band, buyerType, audience, product, channel, buyerRole, intentStage, job, triggerType), take is_any_of or is_none_of and comma-separated ids from business_customer_filter_options_get_v2 (buyerType takes consumer or organization), `none` for a customer with no value. createdAt takes on_or_after or on_or_before and an ISO date, or between and `from..to`, read in UTC.","schema":{"description":"Field conditions, each `<field>:<operator>:<value>`. Text fields (location, employer, trigger) take contains, does_not_contain, is or starts_with and the words. Number fields (age, householdIncome, companySize, annualRevenue) take gt, gte, lt, lte or eq and a number, or between and `min..max`. Classification fields, each band under its fact's key as <key>.band (gender, age.band, language, market, areaType, education, lifeStage, householdIncome.band, occupation, seniority, companySize.band, buyerType, audience, product, channel, buyerRole, intentStage, job, triggerType), take is_any_of or is_none_of and comma-separated ids from business_customer_filter_options_get_v2 (buyerType takes consumer or organization), `none` for a customer with no value. createdAt takes on_or_after or on_or_before and an ISO date, or between and `from..to`, read in UTC.","maxItems":20,"type":"array","items":{"type":"string","minLength":5,"maxLength":4000,"pattern":"^[A-Za-z]+(?:\\.band)?:[a-z_]+:.+$"}}},{"name":"filterMatch","in":"query","required":false,"description":"Whether a customer matches every condition (all, the default) or any one","schema":{"description":"Whether a customer matches every condition (all, the default) or any one","type":"string","enum":["all","any"]}},{"name":"includeStoreCustomers","in":"query","required":false,"description":"Ignored: every pool holds the profile's store customers beside its own.","schema":{"default":false,"description":"Ignored: every pool holds the profile's store customers beside its own.","type":"boolean"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCampaignPoolCustomersListV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/campaign-pool-customers-v3":{"get":{"operationId":"business.campaign-pool-customers.list.v3","summary":"List campaign pool customers (v3)","description":"Deprecated: use business.campaign-pool-customers.list.v4 (business_campaign_pool_customers_list_v4), which takes no includeStoreCustomers: every pool holds the profile's store customers beside its own. This version accepts includeStoreCustomers and ignores it. Page through the customers a new campaign on a business profile can pick, searched by name or job title and narrowed to audiences: each with its table attributes under the customer model's keys (a category, band, Product and Buyer type as id and label), its audiences, place, and why it cannot join when includeIneligible lists those too. customerIds pages only those customers instead, each without a reason. selectedAudienceIds also answers every customer in those audiences, across every page. Page with nextCursor at the same limit.","deprecated":true,"tags":["business"],"x-cli-name":"business-campaign-pool-customers-list-v3","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of customers to return (1–100)","schema":{"default":100,"description":"Number of customers to return (1–100)","type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"businessProfileId","in":"query","required":true,"description":"The business profile.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The business profile."}},{"name":"search","in":"query","required":false,"description":"Words in a name or job title.","schema":{"description":"Words in a name or job title.","type":"string","maxLength":200}},{"name":"audienceIds","in":"query","required":false,"description":"Narrow to these audiences.","schema":{"description":"Narrow to these audiences.","minItems":1,"maxItems":50,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},{"name":"selectedAudienceIds","in":"query","required":false,"description":"Also answer every customer in these audiences as selectedCustomerIds.","schema":{"description":"Also answer every customer in these audiences as selectedCustomerIds.","minItems":1,"maxItems":50,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},{"name":"customerIds","in":"query","required":false,"description":"Page only these customers (a campaign's hand-picked ones); they name no cohort, so each is listed without a reason.","schema":{"description":"Page only these customers (a campaign's hand-picked ones); they name no cohort, so each is listed without a reason.","minItems":1,"maxItems":1000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},{"name":"includeIneligible","in":"query","required":false,"description":"Also list the customers the pick cannot take, after the rest.","schema":{"default":false,"description":"Also list the customers the pick cannot take, after the rest.","type":"boolean"}},{"name":"filters","in":"query","required":false,"description":"Field conditions, each `<field>:<operator>:<value>`. Text fields (location, employer, trigger) take contains, does_not_contain, is or starts_with and the words. Number fields (age, householdIncome, companySize, annualRevenue) take gt, gte, lt, lte or eq and a number, or between and `min..max`. Classification fields, each band under its fact's key as <key>.band (gender, age.band, language, market, areaType, education, lifeStage, householdIncome.band, occupation, seniority, companySize.band, buyerType, audience, product, channel, buyerRole, intentStage, job, triggerType), take is_any_of or is_none_of and comma-separated ids from business_customer_filter_options_get_v2 (buyerType takes consumer or organization), `none` for a customer with no value. createdAt takes on_or_after or on_or_before and an ISO date, or between and `from..to`, read in UTC.","schema":{"description":"Field conditions, each `<field>:<operator>:<value>`. Text fields (location, employer, trigger) take contains, does_not_contain, is or starts_with and the words. Number fields (age, householdIncome, companySize, annualRevenue) take gt, gte, lt, lte or eq and a number, or between and `min..max`. Classification fields, each band under its fact's key as <key>.band (gender, age.band, language, market, areaType, education, lifeStage, householdIncome.band, occupation, seniority, companySize.band, buyerType, audience, product, channel, buyerRole, intentStage, job, triggerType), take is_any_of or is_none_of and comma-separated ids from business_customer_filter_options_get_v2 (buyerType takes consumer or organization), `none` for a customer with no value. createdAt takes on_or_after or on_or_before and an ISO date, or between and `from..to`, read in UTC.","maxItems":20,"type":"array","items":{"type":"string","minLength":5,"maxLength":4000,"pattern":"^[A-Za-z]+(?:\\.band)?:[a-z_]+:.+$"}}},{"name":"filterMatch","in":"query","required":false,"description":"Whether a customer matches every condition (all, the default) or any one","schema":{"description":"Whether a customer matches every condition (all, the default) or any one","type":"string","enum":["all","any"]}},{"name":"includeStoreCustomers","in":"query","required":false,"description":"Ignored: every pool holds the profile's store customers beside its own.","schema":{"default":false,"description":"Ignored: every pool holds the profile's store customers beside its own.","type":"boolean"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCampaignPoolCustomersListV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/campaign-pool-customers-v4":{"get":{"operationId":"business.campaign-pool-customers.list.v4","summary":"List campaign pool customers (v4)","description":"Page through the customers a new campaign on a business profile can pick, its stores' customers included, searched by name or job title and narrowed to audiences: each with its table attributes under the customer model's keys (a category, band, Product and Buyer type as id and label), its audiences, place, and why it cannot join when includeIneligible lists those too. customerIds pages only those customers instead, each without a reason. selectedAudienceIds also answers every customer in those audiences, across every page. Page with nextCursor at the same limit.","tags":["business"],"x-cli-name":"business-campaign-pool-customers-list-v4","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of customers to return (1–100)","schema":{"default":100,"description":"Number of customers to return (1–100)","type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"businessProfileId","in":"query","required":true,"description":"The business profile.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The business profile."}},{"name":"search","in":"query","required":false,"description":"Words in a name or job title.","schema":{"description":"Words in a name or job title.","type":"string","maxLength":200}},{"name":"audienceIds","in":"query","required":false,"description":"Narrow to these audiences.","schema":{"description":"Narrow to these audiences.","minItems":1,"maxItems":50,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},{"name":"selectedAudienceIds","in":"query","required":false,"description":"Also answer every customer in these audiences as selectedCustomerIds.","schema":{"description":"Also answer every customer in these audiences as selectedCustomerIds.","minItems":1,"maxItems":50,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},{"name":"customerIds","in":"query","required":false,"description":"Page only these customers (a campaign's hand-picked ones); they name no cohort, so each is listed without a reason.","schema":{"description":"Page only these customers (a campaign's hand-picked ones); they name no cohort, so each is listed without a reason.","minItems":1,"maxItems":1000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},{"name":"includeIneligible","in":"query","required":false,"description":"Also list the customers the pick cannot take, after the rest.","schema":{"default":false,"description":"Also list the customers the pick cannot take, after the rest.","type":"boolean"}},{"name":"filters","in":"query","required":false,"description":"Field conditions, each `<field>:<operator>:<value>`. Text fields (location, employer, trigger) take contains, does_not_contain, is or starts_with and the words. Number fields (age, householdIncome, companySize, annualRevenue) take gt, gte, lt, lte or eq and a number, or between and `min..max`. Classification fields, each band under its fact's key as <key>.band (gender, age.band, language, market, areaType, education, lifeStage, householdIncome.band, occupation, seniority, companySize.band, buyerType, audience, product, channel, buyerRole, intentStage, job, triggerType), take is_any_of or is_none_of and comma-separated ids from business_customer_filter_options_get_v2 (buyerType takes consumer or organization), `none` for a customer with no value. createdAt takes on_or_after or on_or_before and an ISO date, or between and `from..to`, read in UTC.","schema":{"description":"Field conditions, each `<field>:<operator>:<value>`. Text fields (location, employer, trigger) take contains, does_not_contain, is or starts_with and the words. Number fields (age, householdIncome, companySize, annualRevenue) take gt, gte, lt, lte or eq and a number, or between and `min..max`. Classification fields, each band under its fact's key as <key>.band (gender, age.band, language, market, areaType, education, lifeStage, householdIncome.band, occupation, seniority, companySize.band, buyerType, audience, product, channel, buyerRole, intentStage, job, triggerType), take is_any_of or is_none_of and comma-separated ids from business_customer_filter_options_get_v2 (buyerType takes consumer or organization), `none` for a customer with no value. createdAt takes on_or_after or on_or_before and an ISO date, or between and `from..to`, read in UTC.","maxItems":20,"type":"array","items":{"type":"string","minLength":5,"maxLength":4000,"pattern":"^[A-Za-z]+(?:\\.band)?:[a-z_]+:.+$"}}},{"name":"filterMatch","in":"query","required":false,"description":"Whether a customer matches every condition (all, the default) or any one","schema":{"description":"Whether a customer matches every condition (all, the default) or any one","type":"string","enum":["all","any"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCampaignPoolCustomersListV4Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/campaign-pool-counts/{id}":{"get":{"operationId":"business.campaign-pool-counts.get.v1","summary":"Get campaign pool counts","description":"Deprecated: use business.campaign-pool-counts.get.v2 (business_campaign_pool_counts_get_v2), which takes no includeStoreCustomers: every pool holds the profile's store customers beside its own. This version accepts includeStoreCustomers and ignores it. Count the customers a new campaign on a business profile would target (`id` \"organization\"): the profile's eligible customers, narrowed to audiences, or with targetKind physical_locations every customer of its current stores. 0 when the profile cannot launch campaigns.","deprecated":true,"tags":["business"],"x-cli-name":"business-campaign-pool-counts-get","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The literal \"organization\".","schema":{"type":"string","const":"organization","description":"The literal \"organization\"."}},{"name":"businessProfileId","in":"query","required":true,"description":"The business profile.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The business profile."}},{"name":"audienceIds","in":"query","required":false,"description":"Narrow to these audiences.","schema":{"description":"Narrow to these audiences.","minItems":1,"maxItems":50,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},{"name":"targetKind","in":"query","required":false,"description":"physical_locations counts every customer of the profile's current stores.","schema":{"default":"profile","description":"physical_locations counts every customer of the profile's current stores.","type":"string","enum":["profile","physical_locations"]}},{"name":"includeStoreCustomers","in":"query","required":false,"description":"Ignored: every pool holds the profile's store customers beside its own.","schema":{"default":false,"description":"Ignored: every pool holds the profile's store customers beside its own.","type":"boolean"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCampaignPoolCountsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/campaign-pool-counts-v2/{id}":{"get":{"operationId":"business.campaign-pool-counts.get.v2","summary":"Get campaign pool counts (v2)","description":"Count the customers a new campaign on a business profile would target (`id` \"organization\"): the profile's eligible customers and its stores', narrowed to audiences, or with targetKind physical_locations every customer of its current stores. 0 when the profile cannot launch campaigns.","tags":["business"],"x-cli-name":"business-campaign-pool-counts-get-v2","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The literal \"organization\".","schema":{"type":"string","const":"organization","description":"The literal \"organization\"."}},{"name":"businessProfileId","in":"query","required":true,"description":"The business profile.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The business profile."}},{"name":"audienceIds","in":"query","required":false,"description":"Narrow to these audiences.","schema":{"description":"Narrow to these audiences.","minItems":1,"maxItems":50,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},{"name":"targetKind","in":"query","required":false,"description":"physical_locations counts every customer of the profile's current stores.","schema":{"default":"profile","description":"physical_locations counts every customer of the profile's current stores.","type":"string","enum":["profile","physical_locations"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCampaignPoolCountsGetV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/campaign-customer-selections/resolve":{"get":{"operationId":"business.campaign-customer-selections.resolve.v1","summary":"Resolve campaign customer selections","description":"Deprecated: use business.campaign-customer-selections.resolve.v2 (business_campaign_customer_selections_resolve_v2), which takes no includeStoreCustomers: every pool holds the profile's store customers beside its own. This version accepts includeStoreCustomers and ignores it. Check a new campaign's customer pick before launching it: a saved audience, or explicit customers of the business profile. Answers the targeting a launch takes; refused with each customer that cannot join and why, when the audience is gone, or when the profile cannot launch campaigns.","deprecated":true,"tags":["business"],"x-cli-name":"business-campaign-customer-selections-resolve","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"businessProfileId","in":"query","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"customerIds","in":"query","required":false,"description":"The customers picked by hand; none targets the audience or the whole pool.","schema":{"default":[],"description":"The customers picked by hand; none targets the audience or the whole pool.","maxItems":1000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},{"name":"audienceId","in":"query","required":false,"description":"A saved audience to target instead of explicit customers.","schema":{"description":"A saved audience to target instead of explicit customers.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"includeStoreCustomers","in":"query","required":false,"description":"Ignored: every pool holds the profile's store customers beside its own.","schema":{"default":false,"description":"Ignored: every pool holds the profile's store customers beside its own.","type":"boolean"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCampaignCustomerSelectionsResolveResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/campaign-customer-selections/resolve-v2":{"get":{"operationId":"business.campaign-customer-selections.resolve.v2","summary":"Resolve campaign customer selections (v2)","description":"Check a new campaign's customer pick before launching it: a saved audience, or explicit customers of the business profile or its stores. Answers the targeting a launch takes; refused with each customer that cannot join and why, when the audience is gone, or when the profile cannot launch campaigns.","tags":["business"],"x-cli-name":"business-campaign-customer-selections-resolve-v2","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"businessProfileId","in":"query","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"customerIds","in":"query","required":false,"description":"The customers picked by hand; none targets the audience or the whole pool.","schema":{"default":[],"description":"The customers picked by hand; none targets the audience or the whole pool.","maxItems":1000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},{"name":"audienceId","in":"query","required":false,"description":"A saved audience to target instead of explicit customers.","schema":{"description":"A saved audience to target instead of explicit customers.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCampaignCustomerSelectionsResolveV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/commercial-schedules/{id}":{"get":{"operationId":"business.commercial-schedules.get.v1","summary":"Get commercial schedules","description":"Read a business profile's calendar rules as saved now: the profile version they were read from and the weekly schedule of each product the company sells (revenueLines), with the person's revision behind it when one is in effect. `id` is the profile id; pass profileVersionId as baseVersionId and each line's scheduleRevision.id as expectedRevisionId when updating.","tags":["business"],"x-cli-name":"business-commercial-schedules-get","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The business profile id.","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The business profile id."}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCommercialSchedulesGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/commercial-schedules/update":{"post":{"operationId":"business.commercial-schedules.update.v1","summary":"Update commercial schedules","description":"Save calendar rules for products (revenue lines) of an active business profile, all or none: each changed line takes a new schedule revision in your name (a null schedule returns it to research's), and every active or paused campaign on the profile re-plans from now on. Refused with STALE_WRITE when a line changed since you read it; read the rules again. Returns each line as stored.","tags":["business"],"x-cli-name":"business-commercial-schedules-update","x-point11-scope":"business:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCommercialSchedulesUpdateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCommercialSchedulesUpdateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/crm-connections":{"get":{"operationId":"business.crm-connections.list.v1","summary":"List crm connections","description":"List each CRM provider (HubSpot, Salesforce) with whether this environment offers it, the organization's connection to it (connection id, account label, who connected it and when), its derived health and reason, and its sync-source and followed-contact counts. Read this first: every other CRM operation names a connectionId from here.","tags":["business"],"x-cli-name":"business-crm-connections-list","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmConnectionsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/crm-connection-activities":{"get":{"operationId":"business.crm-connection-activities.list.v1","summary":"List crm connection activities","description":"List one CRM provider's connection activity, newest first: connects and disconnects, imports, sync-source changes, auto-follows and mapping saves, each with its actor and the ids it touched. Page with nextCursor.","tags":["business"],"x-cli-name":"business-crm-connection-activities-list","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of entries to return (1–50)","schema":{"default":50,"description":"Number of entries to return (1–50)","type":"integer","minimum":1,"maximum":50}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"provider","in":"query","required":true,"schema":{"type":"string","enum":["hubspot","salesforce"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmConnectionActivitiesListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/crm-collections/{id}":{"get":{"operationId":"business.crm-collections.get.v1","summary":"Get crm collections","description":"Get every record set one CRM connection (id is its connectionId) offers for an object type: every record, each HubSpot list, or each Salesforce list view, with the provider's own size when it is cheap to read.","tags":["business"],"x-cli-name":"business-crm-collections-get","x-point11-scope":"business:read","security":[{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The CRM connection's id","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The CRM connection's id"}},{"name":"objectType","in":"query","required":true,"schema":{"type":"string","enum":["contacts","companies","leads"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmCollectionsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/crm-records/load":{"get":{"operationId":"business.crm-records.load.v1","summary":"Load crm records","description":"Read a connected CRM record set whole: every record of everything, a HubSpot list or a Salesforce list view, in the provider's stable order, with the values of the named columns (never a locked field). Start with fieldsOnly (no cursor): the object's field catalog, the set's total and starts, cursors that together read every record exactly once. Then read each start's chain chunk by chunk, each read naming its cursor and columns, following nextCursor until it is null, the chains side by side; a chunk carries no catalog, total or starts. mode is audience (the default: only fields an anonymous audience may map) or contacts (the follow picker's: also each contact's name and email), which answers the member's own Point11 dashboard session alone. Nothing is stored.","tags":["business"],"x-cli-name":"business-crm-records-load","x-point11-scope":"business:read","security":[{"oauth":[]}],"parameters":[{"name":"connectionId","in":"query","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"objectType","in":"query","required":true,"schema":{"type":"string","enum":["contacts","companies","leads"]}},{"name":"listKind","in":"query","required":true,"schema":{"type":"string","enum":["all","list","list_view"]}},{"name":"listId","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":200}},{"name":"listLabel","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":200}},{"name":"mode","in":"query","required":false,"schema":{"type":"string","enum":["audience","contacts"]}},{"name":"columns","in":"query","required":false,"schema":{"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":200}}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":8000}},{"name":"fieldsOnly","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmRecordsLoadResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/crm-transcript-fields/{id}":{"get":{"operationId":"business.crm-transcript-fields.get.v1","summary":"Get crm transcript fields","description":"Read where a connected CRM keeps call transcripts (id is the provider): HubSpot's text properties on calls or meetings, or whether Salesforce exposes conversation transcripts. business_crm_contacts_follow needs a HubSpot transcript property from here.","tags":["business"],"x-cli-name":"business-crm-transcript-fields-get","x-point11-scope":"business:read","security":[{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","enum":["hubspot","salesforce"]}},{"name":"objectType","in":"query","required":false,"schema":{"type":"string","enum":["calls","meetings"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmTranscriptFieldsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/crm-contacts":{"get":{"operationId":"business.crm-contacts.list.v1","summary":"List crm contacts","description":"List the CRM contacts the organization follows as named customers, newest first, filtered by status or a name search: each one's CRM identity, customer, state, last update, and what a member may do next. Page with nextCursor.","tags":["business"],"x-cli-name":"business-crm-contacts-list","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of contacts to return (1–1000)","schema":{"default":20,"description":"Number of contacts to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["following","paused","unavailable","retired"]}},{"name":"q","in":"query","required":false,"schema":{"type":"string","maxLength":200}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmContactsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/crm-contacts/follow":{"post":{"operationId":"business.crm-contacts.follow.v1","summary":"Follow crm contacts","description":"Follow up to 100 CRM contact records as named customers of one business profile, reading their call transcripts since historySince; records already followed or forgotten are skipped, never charged. Following is paid; Billing's refusal names this step.","tags":["business"],"x-cli-name":"business-crm-contacts-follow","x-point11-scope":"business:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmContactsFollowRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmContactsFollowResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/crm-contacts/refresh":{"post":{"operationId":"business.crm-contacts.refresh.v1","summary":"Refresh crm contacts","description":"Ask for one followed contact to update now from its CRM (\"changes\") or be rebuilt from all its evidence (\"rebuild\"). Read business_crm_contact_refresh_disclosures_get first to see what it would do.","tags":["business"],"x-cli-name":"business-crm-contacts-refresh","x-point11-scope":"business:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmContactsRefreshRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmContactsRefreshResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/crm-contacts/pause":{"post":{"operationId":"business.crm-contacts.pause.v1","summary":"Pause crm contacts","description":"Stop keeping one followed contact in sync; its customer and history stay, and business_crm_contacts_resume starts it again.","tags":["business"],"x-cli-name":"business-crm-contacts-pause","x-point11-scope":"business:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmContactsPauseRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmContactsPauseResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/crm-contacts/resume":{"post":{"operationId":"business.crm-contacts.resume.v1","summary":"Resume crm contacts","description":"Resume keeping one paused contact in sync; it takes a follow slot again and updates now.","tags":["business"],"x-cli-name":"business-crm-contacts-resume","x-point11-scope":"business:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmContactsResumeRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmContactsResumeResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/crm-contacts/forget":{"post":{"operationId":"business.crm-contacts.forget.v1","summary":"Forget crm contacts","description":"Forget one followed contact: it stops syncing at once and its personal data is erased after the grace period, until which business_crm_contacts_restore brings it back. Returns when erasure is due.","tags":["business"],"x-cli-name":"business-crm-contacts-forget","x-point11-scope":"business:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmContactsForgetRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmContactsForgetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/crm-contacts/restore":{"post":{"operationId":"business.crm-contacts.restore.v1","summary":"Restore crm contacts","description":"Restore one forgotten contact before its personal data is erased. It comes back paused; business_crm_contacts_resume follows it again.","tags":["business"],"x-cli-name":"business-crm-contacts-restore","x-point11-scope":"business:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmContactsRestoreRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmContactsRestoreResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/crm-contact-refresh-disclosures/{id}":{"get":{"operationId":"business.crm-contact-refresh-disclosures.get.v1","summary":"Get crm contact refresh disclosures","description":"Read what updating one followed contact (id is its contact id) would do before asking: whether it is included, who the sync owner is, the follow limit, how soon it would run, and what changed since the last update.","tags":["business"],"x-cli-name":"business-crm-contact-refresh-disclosures-get","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The followed contact's id","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The followed contact's id"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmContactRefreshDisclosuresGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/crm-mapping-drafts/create-v4":{"post":{"operationId":"business.crm-mapping-drafts.create.v4","summary":"Create crm mapping drafts (v4)","description":"Draft a field mapping for a CSV's headers and samples or a connected CRM object: each field with its proposed Point11 target and who decided it. A customer attribute is named by its customer catalog key (jobTitle, companySize, buyerRole, ...); an account fact or account context by its own name (industry, context, public_figure_context for a field holding a public figure who owns, founded or fronts the account). With propose, one paid model proposal fills the fields nobody decided, keyed by the Idempotency-Key; save the result with business_crm_mapping_versions_create_v2.","tags":["business"],"x-cli-name":"business-crm-mapping-drafts-create-v4","x-point11-scope":"business:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmMappingDraftsCreateV4Request"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmMappingDraftsCreateV4Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/crm-mapping-previews/create-v3":{"post":{"operationId":"business.crm-mapping-previews.create.v3","summary":"Create crm mapping previews (v3)","description":"Preview what Point11 keeps from at most five rows under a draft mapping: each mapped value as its customer attribute or account fact holds it after the CRM value policy (a band by its label, a place by its codes), and which cells it drops. Nothing is stored or sent to a model.","tags":["business"],"x-cli-name":"business-crm-mapping-previews-create-v3","x-point11-scope":"business:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmMappingPreviewsCreateV3Request"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmMappingPreviewsCreateV3Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/crm-mapping-versions/create-v2":{"post":{"operationId":"business.crm-mapping-versions.create.v2","summary":"Create crm mapping versions (v2)","description":"Save a member's field choices over a draft as the next immutable mapping version of its subject, naming the version it edits as parentVersionId; a customer attribute target is its customer catalog key. created is false when the choices equal the current version; uploads and imports name the version they read through.","tags":["business"],"x-cli-name":"business-crm-mapping-versions-create-v2","x-point11-scope":"business:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmMappingVersionsCreateV2Request"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmMappingVersionsCreateV2Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/crm-mapping-versions-v4/{id}":{"get":{"operationId":"business.crm-mapping-versions.get.v4","summary":"Get crm mapping versions (v4)","description":"Get one mapping version with every field, its decision (a customer attribute by its customer catalog key, public_figure_context for a field holding a public figure who owns, founded or fronts the account), and who decided it; with compare, also the field-level difference from that earlier version.","tags":["business"],"x-cli-name":"business-crm-mapping-versions-get-v4","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"compare","in":"query","required":false,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmMappingVersionsGetV4Response"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/crm-mapping-lineages/{id}":{"get":{"operationId":"business.crm-mapping-lineages.get.v1","summary":"Get crm mapping lineages","description":"Get one mapping lineage (its subject, current version and drift) with a page of its versions, newest first, older than before when given.","tags":["business"],"x-cli-name":"business-crm-mapping-lineages-get","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"before","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":2147483647}},{"name":"limit","in":"query","required":false,"schema":{"default":20,"type":"integer","minimum":1,"maximum":50}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmMappingLineagesGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/crm-sources":{"get":{"operationId":"business.crm-sources.list.v1","summary":"List crm sources","description":"List the organization's CRM uploads, connector imports and sync sources, newest first or by name, filtered to live syncs or one-off imports, by status or by a name search: each one's scope, mapping, rows, runs, schedule and failure, with the total. Archived uploads and imports are left out unless archived is true, which lists them alone. Page with nextCursor.","tags":["business"],"x-cli-name":"business-crm-sources-list","x-point11-scope":"business:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of sources to return (1–50)","schema":{"default":20,"description":"Number of sources to return (1–50)","type":"integer","minimum":1,"maximum":50}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"live","in":"query","required":false,"description":"true lists only live syncs (lists kept updated and followed contacts segments); false only one-off uploads and imports; omitted, every source","schema":{"description":"true lists only live syncs (lists kept updated and followed contacts segments); false only one-off uploads and imports; omitted, every source","type":"boolean"}},{"name":"q","in":"query","required":false,"schema":{"type":"string","maxLength":200}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["queued","reading","processing","ready","unchanged","failed","active","paused"]}},{"name":"archived","in":"query","required":false,"description":"true lists only archived uploads and imports (business_crm_uploads_restore and business_crm_imports_restore bring them back); omitted or false leaves them out","schema":{"description":"true lists only archived uploads and imports (business_crm_uploads_restore and business_crm_imports_restore bring them back); omitted or false leaves them out","type":"boolean"}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","enum":["recent","name"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmSourcesListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/crm-sync-sources/create":{"post":{"operationId":"business.crm-sync-sources.create.v1","summary":"Create crm sync sources","description":"Keep a CRM scope in sync: follow a segment's contacts (mode \"contacts\": a list, list view, record owner, or every record, backfilled now), or keep a committed connector import updated on a cadence (mode \"audience\").","tags":["business"],"x-cli-name":"business-crm-sync-sources-create","x-point11-scope":"business:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmSyncSourcesCreateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmSyncSourcesCreateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/crm-sync-sources/update":{"post":{"operationId":"business.crm-sync-sources.update.v1","summary":"Update crm sync sources","description":"Change one sync source: pause, resume or retire it, switch a segment's auto-follow, or change a kept list's cadence. Retiring never unfollows contacts; retiring a kept list stops its schedule and keeps its versions.","tags":["business"],"x-cli-name":"business-crm-sync-sources-update","x-point11-scope":"business:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmSyncSourcesUpdateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmSyncSourcesUpdateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/crm-sync-sources/sync":{"post":{"operationId":"business.crm-sync-sources.sync.v1","summary":"Sync crm sync sources","description":"Sync one active source now: a contacts segment re-reads its connection, and a kept list runs one extra import (keyed by the Idempotency-Key) whose importId this returns.","tags":["business"],"x-cli-name":"business-crm-sync-sources-sync","x-point11-scope":"business:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmSyncSourcesSyncRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmSyncSourcesSyncResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/crm-imports/create":{"post":{"operationId":"business.crm-imports.create.v1","summary":"Create crm imports","description":"Import one CRM record set whole, or the records picked from it (selection: record ids business_crm_records_load returned), into a business profile through a saved audience mapping version; the import reads and processes on its own, and business_crm_sources_list shows its progress. keepInSync keeps a whole record set updated on a cadence. customerTargetCount asks for that many customers once its CRM Profile is built, billed as Create customers is; the list shows them.","tags":["business"],"x-cli-name":"business-crm-imports-create","x-point11-scope":"business:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmImportsCreateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmImportsCreateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/crm-imports/update":{"post":{"operationId":"business.crm-imports.update.v1","summary":"Update crm imports","description":"Rename one kept list, named by its first import's id (originImportId in business_crm_sources_list): the name that list shows for it, and its schedule's while it is kept updated. Refused while that import is still queued or reading.","tags":["business"],"x-cli-name":"business-crm-imports-update","x-point11-scope":"business:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmImportsUpdateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmImportsUpdateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/crm-imports/delete":{"post":{"operationId":"business.crm-imports.delete.v1","summary":"Delete crm imports","description":"Permanently delete a kept list (a connector import and every version its updates made), after the user confirms: its sync stops first, then each version's profile and never-sampled customers are deleted and customers frozen into a campaign are retired.","tags":["business"],"x-cli-name":"business-crm-imports-delete","x-point11-scope":"business:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}},{"name":"Point11-Confirm","in":"header","required":true,"description":"Explicit human confirmation of this operation's effect.","schema":{"type":"string","enum":["true"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmImportsDeleteRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmImportsDeleteResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/crm-imports/archive":{"post":{"operationId":"business.crm-imports.archive.v1","summary":"Archive crm imports","description":"Archive a kept list (a connector import and every version its updates made), named by its first import's id (originImportId in business_crm_sources_list), after the user confirms: it leaves the imports list for its archived filter, its sync stops if one keeps it updated, and it can't be kept updated until business_crm_imports_restore brings it back. Its versions and the customers made from them stay. Refused while one of its runs is still running.","tags":["business"],"x-cli-name":"business-crm-imports-archive","x-point11-scope":"business:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}},{"name":"Point11-Confirm","in":"header","required":true,"description":"Explicit human confirmation of this operation's effect.","schema":{"type":"string","enum":["true"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmImportsArchiveRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmImportsArchiveResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/crm-imports/restore":{"post":{"operationId":"business.crm-imports.restore.v1","summary":"Restore crm imports","description":"Restore an archived kept list, named by its first import's id, to the imports list, after the user confirms. A sync its archive stopped stays stopped; keep it updated again with business_crm_sync_sources_create.","tags":["business"],"x-cli-name":"business-crm-imports-restore","x-point11-scope":"business:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}},{"name":"Point11-Confirm","in":"header","required":true,"description":"Explicit human confirmation of this operation's effect.","schema":{"type":"string","enum":["true"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmImportsRestoreRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmImportsRestoreResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/crm-uploads/create":{"post":{"operationId":"business.crm-uploads.create.v1","summary":"Create crm uploads","description":"Upload up to 20,000 CRM rows (at most 4 MB of JSON) keyed by the column names a saved CSV mapping version maps, into a business profile. Possible personal identifiers are dropped and counted, and the CRM Profile extraction run starts; follow its runId with platform_runs_get_v2. customerTargetCount asks for that many customers once the profile is built, billed as Create customers is: at most one per accepted row (empty and exactly repeated rows are not accepted) and at most 5,000, else the upload is refused with INVALID_INPUT; business_crm_sources_list shows them.","tags":["business"],"x-cli-name":"business-crm-uploads-create","x-point11-scope":"business:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmUploadsCreateRequest"}}}},"responses":{"202":{"description":"Accepted: the durable run started. Follow it with `GET /api/v1/platform/runs-v2/{id}`.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmUploadsCreateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/crm-uploads/update":{"post":{"operationId":"business.crm-uploads.update.v1","summary":"Update crm uploads","description":"Rename one CSV upload: the name business_crm_sources_list shows for it. Refused while the upload is still processing. A connector import is renamed with business_crm_imports_update.","tags":["business"],"x-cli-name":"business-crm-uploads-update","x-point11-scope":"business:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmUploadsUpdateRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmUploadsUpdateResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/crm-uploads/delete":{"post":{"operationId":"business.crm-uploads.delete.v1","summary":"Delete crm uploads","description":"Permanently delete one CRM upload, after the user confirms: its profile and remaining rows, and customers built only from it that no campaign sampled; customers frozen into a campaign are retired. Returns how many of each.","tags":["business"],"x-cli-name":"business-crm-uploads-delete","x-point11-scope":"business:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}},{"name":"Point11-Confirm","in":"header","required":true,"description":"Explicit human confirmation of this operation's effect.","schema":{"type":"string","enum":["true"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmUploadsDeleteRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmUploadsDeleteResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/crm-uploads/archive":{"post":{"operationId":"business.crm-uploads.archive.v1","summary":"Archive crm uploads","description":"Archive one CSV upload, after the user confirms: it leaves the imports list for its archived filter until business_crm_uploads_restore brings it back. Its profile and the customers made from it stay. Refused while the upload is still processing. A connector import is archived with business_crm_imports_archive.","tags":["business"],"x-cli-name":"business-crm-uploads-archive","x-point11-scope":"business:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}},{"name":"Point11-Confirm","in":"header","required":true,"description":"Explicit human confirmation of this operation's effect.","schema":{"type":"string","enum":["true"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmUploadsArchiveRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmUploadsArchiveResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/crm-uploads/restore":{"post":{"operationId":"business.crm-uploads.restore.v1","summary":"Restore crm uploads","description":"Restore an archived CSV upload to the imports list, after the user confirms.","tags":["business"],"x-cli-name":"business-crm-uploads-restore","x-point11-scope":"business:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}},{"name":"Point11-Confirm","in":"header","required":true,"description":"Explicit human confirmation of this operation's effect.","schema":{"type":"string","enum":["true"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmUploadsRestoreRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmUploadsRestoreResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/business/crm-uploads/retry":{"post":{"operationId":"business.crm-uploads.retry.v1","summary":"Retry crm uploads","description":"Retry a failed CRM upload's extraction over the rows it had not processed yet (kept for seven days after the failure); follow the returned runId with platform_runs_get_v2.","tags":["business"],"x-cli-name":"business-crm-uploads-retry","x-point11-scope":"business:write","security":[{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmUploadsRetryRequest"}}}},"responses":{"202":{"description":"Accepted: the durable run started. Follow it with `GET /api/v1/platform/runs-v2/{id}`.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCrmUploadsRetryResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/reports/datasets":{"get":{"operationId":"reports.datasets.list.v1","summary":"List datasets","description":"List the datasets a report can read, or one product's (`product`: discovery, experience or research). Each names its id, label and description, whether it aggregates (rows and columns grouped by its dimensions, each cell its measures) or lists records (one row per interaction, its dimensions as fields), how it reads time (`window`: the trailing 30-day results window ending on the as-of day a date range chooses; `range`: the range itself), its dimensions and measures, how many row and column dimensions a report may group by, whether it compares with the window 30 days earlier, the records dataset a cell opens (`drill`), and what a new report of it opens on.","tags":["reports"],"x-cli-name":"reports-datasets-list","x-point11-scope":"reports:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"product","in":"query","required":false,"description":"Only this product's datasets.","schema":{"description":"Only this product's datasets.","type":"string","enum":["discovery","experience","research"]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportsDatasetsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/reports/report-tables/{id}":{"get":{"operationId":"reports.report-tables.get.v1","summary":"Get report tables","description":"Read one page of a report's table: pass what the report reads as `id` (the campaign its definition's `scope.campaignId` names, or the organization's id for a report of every campaign, `scope.campaignId` null, narrowed to one business profile's by `scope.profileId`) and the report definition as JSON text (`definition`, the shape reports_saved_reports_save takes; a definition whose scope names another campaign is not found under `id`, as is a campaign of another profile than `scope.profileId`). An aggregate report answers its flat columns (each measure under each combination of column values, shown as itself or as a share of its row, column or total), this page of rows with each value's precision and, when it compares, its value over the window 30 days earlier, the grand total row and, when its definition draws a chart (`chart`), that chart (`table.chart`): the first `chart.topN` categories along x (every day, at most 1,000; every part of a pie, at most 5) and at most 5 series, each point the table's own cell at that row and column, with how many categories and series the report holds and no Other for the rest, or why the data cannot draw it (`status: refused`); a records report answers this page of interactions with the fields it shows. Every figure is the product's own, as its dashboard reads it for the same campaign and dates. A definition that does not fit its dataset is 400 INVALID_INPUT with `details.issues` naming each field; a campaign the organization has no such product campaign for is 404 RESOURCE_NOT_FOUND; a campaign with no results in the scope answers `status: no-results`. Page with `after` (the previous page's `nextCursor`) and `pageSize`.","tags":["reports"],"x-cli-name":"reports-report-tables-get","x-point11-scope":"reports:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"What the report reads: its definition's `scope.campaignId`, or the organization's id when the report reads every campaign of its product (`scope.campaignId` null).","schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"What the report reads: its definition's `scope.campaignId`, or the organization's id when the report reads every campaign of its product (`scope.campaignId` null)."}},{"name":"definition","in":"query","required":true,"description":"The report definition as JSON text: `{version: 1, grain: \"aggregate\", dataset, scope: {campaignId (null: every campaign of the product, pooled, where the dataset allows it), dateRange}, rows, columns, values: [{measure, showAs}], filters: [{dimension, values}], sort, compare, chart: {mark, orientation, x, y, topN, labels} | null}` or `{version: 1, grain: \"records\", dataset, scope, fields, filters, sort: {field, direction} | null}`, its keys the dataset's (reports.datasets.list.v1).","schema":{"description":"The report definition as JSON text: `{version: 1, grain: \"aggregate\", dataset, scope: {campaignId (null: every campaign of the product, pooled, where the dataset allows it), dateRange}, rows, columns, values: [{measure, showAs}], filters: [{dimension, values}], sort, compare, chart: {mark, orientation, x, y, topN, labels} | null}` or `{version: 1, grain: \"records\", dataset, scope, fields, filters, sort: {field, direction} | null}`, its keys the dataset's (reports.datasets.list.v1).","type":"string","minLength":2,"maxLength":8192}},{"name":"after","in":"query","required":false,"description":"The previous page's `nextCursor`; omit it for the first page.","schema":{"default":null,"description":"The previous page's `nextCursor`; omit it for the first page.","anyOf":[{"type":"string","minLength":1,"maxLength":1024},{"type":"null"}]}},{"name":"pageSize","in":"query","required":false,"description":"Rows per page (1–1000).","schema":{"default":20,"description":"Rows per page (1–1000).","type":"integer","minimum":1,"maximum":1000}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportsReportTablesGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/reports/report-tables/export":{"get":{"operationId":"reports.report-tables.export.v1","summary":"Export report tables","description":"Export a report's whole table as one CSV file, with the values the report shows, named after the report (`name`) when given. Pass the report definition as JSON text (`definition`, as reports_report_tables_get takes it). Answers the file's name, type and size with a short-lived `url` to GET it (fetch it before `expiresAt`; call again for a fresh export). A definition that does not fit its dataset is 400 INVALID_INPUT; a campaign the organization has no such product campaign for is 404 RESOURCE_NOT_FOUND; a campaign with no results in the scope is 409 PRECONDITION_FAILED (`details.reason: no_results`). Every export is audited.","tags":["reports"],"x-cli-name":"reports-report-tables-export","x-point11-scope":"reports:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"definition","in":"query","required":true,"description":"The report definition as JSON text: `{version: 1, grain: \"aggregate\", dataset, scope: {campaignId (null: every campaign of the product, pooled, where the dataset allows it), dateRange}, rows, columns, values: [{measure, showAs}], filters: [{dimension, values}], sort, compare, chart: {mark, orientation, x, y, topN, labels} | null}` or `{version: 1, grain: \"records\", dataset, scope, fields, filters, sort: {field, direction} | null}`, its keys the dataset's (reports.datasets.list.v1).","schema":{"description":"The report definition as JSON text: `{version: 1, grain: \"aggregate\", dataset, scope: {campaignId (null: every campaign of the product, pooled, where the dataset allows it), dateRange}, rows, columns, values: [{measure, showAs}], filters: [{dimension, values}], sort, compare, chart: {mark, orientation, x, y, topN, labels} | null}` or `{version: 1, grain: \"records\", dataset, scope, fields, filters, sort: {field, direction} | null}`, its keys the dataset's (reports.datasets.list.v1).","type":"string","minLength":2,"maxLength":8192}},{"name":"name","in":"query","required":false,"description":"The report's name, which names the file; omit it for the dataset's.","schema":{"default":null,"description":"The report's name, which names the file; omit it for the dataset's.","anyOf":[{"type":"string","minLength":1,"maxLength":120},{"type":"null"}]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportsReportTablesExportResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/reports/dimension-values":{"get":{"operationId":"reports.dimension-values.list.v1","summary":"List dimension values","description":"List the values one dimension can take in a report's scope, as the report's Filter offers them: pass the report definition as JSON text (`definition`, as reports_report_tables_get takes it) and a dimension its dataset filters by (`dimension`, as reports_datasets_list names it). Each value names its `key`, which a filter's `values` keeps, and its `label` as the product names it (a customer's name, a store's, a run's start day, an outcome). A dimension a report can group by lists the values the product's figures hold in the definition's campaign and dates, under its other filters, ordered by label; one a dataset only filters by (a store, a customer, a run) or a records field nothing groups by (an outcome) lists every value the product offers there in the product's own order, such as the customers and stores of the campaigns the report reads. The definition's own filter on the dimension narrows nothing. `search` keeps the values whose label contains it, any case, or whose key is it. A definition that does not fit its dataset, or a dimension its dataset does not filter by, is 400 INVALID_INPUT with `details.issues`; a campaign the organization has no such product campaign for is 404 RESOURCE_NOT_FOUND. Page with `limit` and `cursor`.","tags":["reports"],"x-cli-name":"reports-dimension-values-list","x-point11-scope":"reports:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"definition","in":"query","required":true,"description":"The report definition as JSON text: `{version: 1, grain: \"aggregate\", dataset, scope: {campaignId (null: every campaign of the product, pooled, where the dataset allows it), dateRange}, rows, columns, values: [{measure, showAs}], filters: [{dimension, values}], sort, compare, chart: {mark, orientation, x, y, topN, labels} | null}` or `{version: 1, grain: \"records\", dataset, scope, fields, filters, sort: {field, direction} | null}`, its keys the dataset's (reports.datasets.list.v1).","schema":{"description":"The report definition as JSON text: `{version: 1, grain: \"aggregate\", dataset, scope: {campaignId (null: every campaign of the product, pooled, where the dataset allows it), dateRange}, rows, columns, values: [{measure, showAs}], filters: [{dimension, values}], sort, compare, chart: {mark, orientation, x, y, topN, labels} | null}` or `{version: 1, grain: \"records\", dataset, scope, fields, filters, sort: {field, direction} | null}`, its keys the dataset's (reports.datasets.list.v1).","type":"string","minLength":2,"maxLength":8192}},{"name":"dimension","in":"query","required":true,"description":"A dimension key the definition's dataset filters by.","schema":{"type":"string","minLength":1,"maxLength":64,"description":"A dimension key the definition's dataset filters by."}},{"name":"search","in":"query","required":false,"description":"Keep the values whose label contains this text, any case, or whose key is it; omit it for every value.","schema":{"default":null,"description":"Keep the values whose label contains this text, any case, or whose key is it; omit it for every value.","anyOf":[{"type":"string","maxLength":256},{"type":"null"}]}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportsDimensionValuesListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/reports/saved-reports":{"get":{"operationId":"reports.saved-reports.list.v1","summary":"List saved reports","description":"List the organization's saved reports, most recently changed first: active and archived ones by default, or one status; narrowed to one product, one campaign, or names containing `query`. A deleted report is never listed. Each names its product, dataset, campaign, status, creator and when it was created and last changed.","tags":["reports"],"x-cli-name":"reports-saved-reports-list","x-point11-scope":"reports:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return (1–1000)","schema":{"default":20,"description":"Number of items to return (1–1000)","type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned as nextCursor by the previous page","schema":{"description":"Opaque cursor returned as nextCursor by the previous page","type":"string","minLength":1,"maxLength":1024}},{"name":"product","in":"query","required":false,"description":"Only this product's reports.","schema":{"description":"Only this product's reports.","type":"string","enum":["discovery","experience","research"]}},{"name":"campaignId","in":"query","required":false,"description":"Only the reports that read this campaign.","schema":{"description":"Only the reports that read this campaign.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"status","in":"query","required":false,"description":"Only reports in this status; omit it for active and archived ones.","schema":{"description":"Only reports in this status; omit it for active and archived ones.","type":"string","enum":["active","archived"]}},{"name":"query","in":"query","required":false,"description":"Only reports whose name contains this text, in any case.","schema":{"description":"Only reports whose name contains this text, in any case.","type":"string","minLength":1,"maxLength":120}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportsSavedReportsListResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/reports/saved-reports/{id}":{"get":{"operationId":"reports.saved-reports.get.v1","summary":"Get saved reports","description":"Read one saved report by id: its name, product, dataset, campaign, status and report definition, and `updatedAt`, which a replace names to show what it edited. A deleted report, or one that is not the organization's, is 404 RESOURCE_NOT_FOUND.","tags":["reports"],"x-cli-name":"reports-saved-reports-get","x-point11-scope":"reports:read","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportsSavedReportsGetResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/reports/saved-reports/save":{"post":{"operationId":"reports.saved-reports.save.v1","summary":"Save saved reports","description":"Create or replace a saved report: a name and a report definition, which names the dataset and the campaign and date range it reads. Omit `id` to create one, which the server names; a retry with the same Idempotency-Key returns the report its first attempt made. Pass the `id` of one of the organization's reports and the `updatedAt` you read it at (`expectedUpdatedAt`) to replace it: a report changed since is 409 STALE_WRITE (read it again), a deleted one is 409 PRECONDITION_FAILED, and an id that is not the organization's report is 404 RESOURCE_NOT_FOUND. A definition that does not fit its dataset is 400 INVALID_INPUT with `details.issues`; a campaign that is not the organization's campaign of the dataset's product is 404 RESOURCE_NOT_FOUND.","tags":["reports"],"x-cli-name":"reports-saved-reports-save","x-point11-scope":"reports:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportsSavedReportsSaveRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportsSavedReportsSaveResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}},"/api/v1/reports/saved-reports/set-status":{"post":{"operationId":"reports.saved-reports.set-status.v1","summary":"Set status saved reports","description":"Archive, restore (`active`) or delete saved reports by id. Deleting is permanent: the report's name and definition are cleared and no status leaves it; confirm with the user before deleting. A report already in the status stays; one that cannot move there (a deleted one) and an id that is not the organization's report are left out. Answers each report this call changed, with its status.","tags":["reports"],"x-cli-name":"reports-saved-reports-set-status","x-point11-scope":"reports:write","security":[{"apiKey":[]},{"oauth":[]}],"parameters":[{"name":"Point11-Organization","in":"header","required":false,"description":"Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.","schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"UUID naming this intent. Retry with the same key; reuse for other input is 409.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportsSavedReportsSetStatusRequest"}}}},"responses":{"200":{"description":"Success.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportsSavedReportsSetStatusResponse"}}}},"400":{"description":"The input, query, or Idempotency-Key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"401":{"description":"The bearer is missing, expired, or not accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"402":{"description":"Billing refused the write: the code names the reason and `details.reason` carries it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"403":{"description":"The credential lacks the operation's scope or role, or the operation needs a different door.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"404":{"description":"The resource or organization does not exist for this caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"405":{"description":"This path takes another HTTP method, named in `Allow`.","headers":{"Allow":{"description":"The HTTP methods this path takes.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"409":{"description":"The request conflicts with current state or with prior use of its Idempotency-Key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"413":{"description":"The request, or the answer it asks for, is too large; narrow it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"429":{"description":"The credential's rate budget is spent; retry after `Retry-After` seconds.","headers":{"RateLimit-Limit":{"description":"Requests this credential may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"500":{"description":"An unexpected server failure; retry later. Only `request_id` identifies it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"503":{"description":"A dependency is temporarily unavailable; retry after `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}},"default":{"description":"Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationError"}}}}}}}},"x-cli-config":{"security":"oauth","params":{"client_id":"https://point11.ai/api/oauth/cli-client.json","scopes":"openid offline_access","resource":"https://point11.ai/api/v1"}}}