Contacts, conversations, deals created, deals won and won value per origin, with the ratios between them. Use it to see which channels and campaigns produce revenue, not only volume.
group_by picks what a row is. channel → source → campaign → adset → ad is a drill-down: ask for the next level and name the parent rows’ keys in channel, source, campaign and adset. capture_source, entry_link, whatsapp_number and utm_campaign are flat views.
Attribution. Each count uses the origin of the record itself: contacts by the contact’s origin, conversations by the conversation’s, deals by the deal’s. The response states the rule in attribution_rule. Records without an origin are one unknown row, never dropped.
date_basis is contact_created (a cohort of contacts created in the window) or deal_created (each record by its own creation date). captured_only leaves out origins that were inferred, estimated or repaired.
Results are bounded: the top limit rows by sort_by, then one other row for the rest. Only records the token’s holder may see are counted; a workspace token counts the whole workspace. The window defaults to the 30 days ending now and spans at most 366 days. Needs the contacts:read, deals:read and conversations:read scopes.
A workspace API token (sk_live_...) or an OAuth access token (oat_live_...). Create workspace tokens in Settings > API. Send either as Authorization: Bearer <token>.
channel, source, campaign, adset and ad are the levels of a drill-down:
ask for the next level with the parent rows' keys as filters. The other
groupings are flat views of the same origins.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Sailer","description":"REST API and MCP servers for your Sailer workspace.","colors":{"primary":"#0EA5E9","light":"#39B5FF","dark":"#0284C7"},"logo":{"light":"https://mintcdn.com/sailer-ai/giKWeWjZ5A9lyZTo/logo/light.svg?fit=max\u0026auto=format\u0026n=giKWeWjZ5A9lyZTo\u0026q=85\u0026s=2fab534de473f28a8e631dc6cd6f958a","dark":"https://mintcdn.com/sailer-ai/giKWeWjZ5A9lyZTo/logo/dark.svg?fit=max\u0026auto=format\u0026n=giKWeWjZ5A9lyZTo\u0026q=85\u0026s=5998985a6c98bb13303b761463c00f54"},"favicon":"https://mintcdn.com/sailer-ai/giKWeWjZ5A9lyZTo/favicon.png?fit=max\u0026auto=format\u0026n=giKWeWjZ5A9lyZTo\u0026q=85\u0026s=15272c0ef455bd61ccc47cf641106e07","appearance":{"default":"system"},"background":{"decoration":"gradient","color":{"light":"#F8FAFC","dark":"#173043"}},"navbar":{"links":[{"href":"https://mysailer.com","label":"Product"}],"primary":{"type":"button","label":"Talk to us","href":"mailto:support@mysailer.com"}},"footer":{"socials":{"website":"https://mysailer.com"}},"fonts":{"family":"Poppins"},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","default":true,"href":""},{"language":"es","navbar":{"links":[{"href":"https://mysailer.com","label":"Producto"}],"primary":{"type":"button","label":"Habla con nosotros","href":"mailto:support@mysailer.com"}},"href":"es"},{"language":"pt-BR","navbar":{"links":[{"href":"https://mysailer.com","label":"Produto"}],"primary":{"type":"button","label":"Fale conosco","href":"mailto:support@mysailer.com"}},"href":"pt-BR"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"sailer-ai","hasAudioNarration":false,"actualSubdomain":"sailer-ai","customDomains":["docs.chatsailer.com"],"gitSource":{"type":"github","owner":"sailerai","repo":"developer-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6ad65192ad717b269af56368","collectionId":"ded60ea5-9045-4658-b9d5-f75f2b626e22","liveDeploymentHistoryId":"6ad65192ad717b269af56368","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae8eab85d9c8c19a16b9a27","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"API Reference","count":72},{"language":"es","tag":"MCP","count":10},{"language":"en","tag":"MCP","count":10},{"language":"pt-BR","tag":"MCP","count":10},{"language":"default","tag":"Conversations","count":9},{"language":"es","tag":"Guías","count":8},{"language":"en","tag":"Guides","count":8},{"language":"pt-BR","tag":"Guias","count":8},{"language":"default","tag":"Contacts","count":8},{"language":"default","tag":"Deals","count":8},{"language":"default","tag":"Campaigns","count":7},{"language":"es","tag":"Primeros pasos","count":6},{"language":"en","tag":"Getting started","count":6},{"language":"pt-BR","tag":"Primeiros passos","count":6},{"language":"default","tag":"Activities","count":6},{"language":"default","tag":"Organizations","count":6},{"language":"es","tag":"Conectar","count":5},{"language":"en","tag":"Connect","count":5},{"language":"pt-BR","tag":"Conectar","count":5},{"language":"default","tag":"Notes","count":5},{"language":"default","tag":"Success Events","count":5},{"language":"es","tag":"Trabajar con la API","count":4},{"language":"en","tag":"Working with the API","count":4},{"language":"pt-BR","tag":"Trabalhando com a API","count":4},{"language":"default","tag":"Audiences","count":3},{"language":"es","tag":"Servidores","count":2},{"language":"en","tag":"Servers","count":2},{"language":"pt-BR","tag":"Servidores","count":2},{"language":"es","tag":"Ayuda","count":1},{"language":"en","tag":"Help","count":1},{"language":"pt-BR","tag":"Ajuda","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"api-reference/reports/origin-report","slug":"/api-reference/reports/origin-report","pageMetadata":{"title":"Origin report","description":"Contacts, conversations, deals created, deals won and won value per origin, with the ratios between them. Use it to see which channels and campaigns produce revenue, not only volume.\n\n`group_by` picks what a row is. `channel` → `source` → `campaign` → `adset` → `ad` is a drill-down: ask for the next level and name the parent rows' `key`s in `channel`, `source`, `campaign` and `adset`. `capture_source`, `entry_link`, `whatsapp_number` and `utm_campaign` are flat views.\n\n**Attribution.** Each count uses the origin of the record itself: contacts by the contact's origin, conversations by the conversation's, deals by the deal's. The response states the rule in `attribution_rule`. Records without an origin are one `unknown` row, never dropped.\n\n`date_basis` is `contact_created` (a cohort of contacts created in the window) or `deal_created` (each record by its own creation date). `captured_only` leaves out origins that were inferred, estimated or repaired.\n\nResults are bounded: the top `limit` rows by `sort_by`, then one `other` row for the rest. Only records the token's holder may see are counted; a workspace token counts the whole workspace. The window defaults to the 30 days ending now and spans at most 366 days. Needs the `contacts:read`, `deals:read` and `conversations:read` scopes.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/reports/origin","href":"/api-reference/reports/origin-report","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Contacts, conversations, deals created, deals won and won value per origin, with the ratios between them. Use it to see which channels and campaigns produce revenue, not only volume.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"group_by\"\n }), \" picks what a row is. \", _jsx(_components.code, {\n children: \"channel\"\n }), \" → \", _jsx(_components.code, {\n children: \"source\"\n }), \" → \", _jsx(_components.code, {\n children: \"campaign\"\n }), \" → \", _jsx(_components.code, {\n children: \"adset\"\n }), \" → \", _jsx(_components.code, {\n children: \"ad\"\n }), \" is a drill-down: ask for the next level and name the parent rows’ \", _jsx(_components.code, {\n children: \"key\"\n }), \"s in \", _jsx(_components.code, {\n children: \"channel\"\n }), \", \", _jsx(_components.code, {\n children: \"source\"\n }), \", \", _jsx(_components.code, {\n children: \"campaign\"\n }), \" and \", _jsx(_components.code, {\n children: \"adset\"\n }), \". \", _jsx(_components.code, {\n children: \"capture_source\"\n }), \", \", _jsx(_components.code, {\n children: \"entry_link\"\n }), \", \", _jsx(_components.code, {\n children: \"whatsapp_number\"\n }), \" and \", _jsx(_components.code, {\n children: \"utm_campaign\"\n }), \" are flat views.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Attribution.\"\n }), \" Each count uses the origin of the record itself: contacts by the contact’s origin, conversations by the conversation’s, deals by the deal’s. The response states the rule in \", _jsx(_components.code, {\n children: \"attribution_rule\"\n }), \". Records without an origin are one \", _jsx(_components.code, {\n children: \"unknown\"\n }), \" row, never dropped.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"date_basis\"\n }), \" is \", _jsx(_components.code, {\n children: \"contact_created\"\n }), \" (a cohort of contacts created in the window) or \", _jsx(_components.code, {\n children: \"deal_created\"\n }), \" (each record by its own creation date). \", _jsx(_components.code, {\n children: \"captured_only\"\n }), \" leaves out origins that were inferred, estimated or repaired.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Results are bounded: the top \", _jsx(_components.code, {\n children: \"limit\"\n }), \" rows by \", _jsx(_components.code, {\n children: \"sort_by\"\n }), \", then one \", _jsx(_components.code, {\n children: \"other\"\n }), \" row for the rest. Only records the token’s holder may see are counted; a workspace token counts the whole workspace. The window defaults to the 30 days ending now and spans at most 366 days. Needs the \", _jsx(_components.code, {\n children: \"contacts:read\"\n }), \", \", _jsx(_components.code, {\n children: \"deals:read\"\n }), \" and \", _jsx(_components.code, {\n children: \"conversations:read\"\n }), \" scopes.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Origin report","description":"Contacts, conversations, deals created, deals won and won value per origin, with the ratios between them. Use it to see which channels and campaigns produce revenue, not only volume.\n\n`group_by` picks what a row is. `channel` → `source` → `campaign` → `adset` → `ad` is a drill-down: ask for the next level and name the parent rows' `key`s in `channel`, `source`, `campaign` and `adset`. `capture_source`, `entry_link`, `whatsapp_number` and `utm_campaign` are flat views.\n\n**Attribution.** Each count uses the origin of the record itself: contacts by the contact's origin, conversations by the conversation's, deals by the deal's. The response states the rule in `attribution_rule`. Records without an origin are one `unknown` row, never dropped.\n\n`date_basis` is `contact_created` (a cohort of contacts created in the window) or `deal_created` (each record by its own creation date). `captured_only` leaves out origins that were inferred, estimated or repaired.\n\nResults are bounded: the top `limit` rows by `sort_by`, then one `other` row for the rest. Only records the token's holder may see are counted; a workspace token counts the whole workspace. The window defaults to the 30 days ending now and spans at most 366 days. Needs the `contacts:read`, `deals:read` and `conversations:read` scopes.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/reports/origin","href":"/api-reference/reports/origin-report","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Contacts, conversations, deals created, deals won and won value per origin, with the ratios between them. Use it to see which channels and campaigns produce revenue, not only volume.\n\n`group_by` picks what a row is. `channel` → `source` → `campaign` → `adset` → `ad` is a drill-down: ask for the next level and name the parent rows' `key`s in `channel`, `source`, `campaign` and `adset`. `capture_source`, `entry_link`, `whatsapp_number` and `utm_campaign` are flat views.\n\n**Attribution.** Each count uses the origin of the record itself: contacts by the contact's origin, conversations by the conversation's, deals by the deal's. The response states the rule in `attribution_rule`. Records without an origin are one `unknown` row, never dropped.\n\n`date_basis` is `contact_created` (a cohort of contacts created in the window) or `deal_created` (each record by its own creation date). `captured_only` leaves out origins that were inferred, estimated or repaired.\n\nResults are bounded: the top `limit` rows by `sort_by`, then one `other` row for the rest. Only records the token's holder may see are counted; a workspace token counts the whole workspace. The window defaults to the 30 days ending now and spans at most 366 days. Needs the `contacts:read`, `deals:read` and `conversations:read` scopes.","operationId":"get_origin_report","parameters":["4e681cf9-6d24-48a9-acc9-925f5b4bea3b","0208d7b9-19e2-4bef-99bd-51c5497419fe","bb0070c5-23f2-47cb-9c72-d1515a15d514","96a900f5-bacf-4cb5-bad1-a60b5aeff756","8fe4afbe-b71c-417d-b9c0-2ea6142a93d1","70c95173-a9c3-43c6-a505-7ca9b7fb68e7","d52ee460-b651-4942-8fde-c988b7c28a4a","fb01b622-132e-4319-acd4-0d1ff2c0fc09","968e713b-9fe2-4551-bf90-0e9da25531bb","719a15ec-4024-4b4b-a2f8-9d532709c18b","f832dda0-9b6a-4412-9f04-074ee08aac84"],"responses":{"200":"a0e961ef-eeca-4e03-825e-dbfe29b49dc7","400":"4be10a88-b7a6-4987-b646-8b922d3ce90b","401":"5f96bdf7-3046-4928-8d3c-2eccd5ed9cdc","403":"dbe00e28-729b-4ae4-ae81-2a0f141d4e97","429":"18d096a6-0a1d-4f88-aed6-ba84beec7b00","500":"9bbec099-37d7-427b-9c97-bae4d5195991"},"security":["ebe553ad-a097-48f9-bf9a-88591ac39a7e"],"summary":"Origin report","tags":["Reports"],"method":"get","type":"path","servers":["1828cdf7-6641-4742-9f37-e597b7306ad2"],"path":"/v1/reports/origin","baseUrlOptions":["https://api.chatsailer.com"],"title":"Origin report","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"4e681cf9-6d24-48a9-acc9-925f5b4bea3b":{"description":"Start of the window, inclusive. Needs a timezone offset.","in":"query","name":"since","required":false,"schema":{"oneOf":[{"type":"string","title":"Since","description":"Start of the window, inclusive. Needs a timezone offset.","format":"date-time","uniqueKey":"oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Since","description":"Start of the window, inclusive. Needs a timezone offset.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time> | null"}},"0208d7b9-19e2-4bef-99bd-51c5497419fe":{"description":"End of the window, exclusive. Defaults to now.","in":"query","name":"until","required":false,"schema":{"oneOf":[{"type":"string","title":"Until","description":"End of the window, exclusive. Defaults to now.","format":"date-time","uniqueKey":"oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Until","description":"End of the window, exclusive. Defaults to now.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time> | null"}},"bb0070c5-23f2-47cb-9c72-d1515a15d514":{"description":"What a row stands for.","in":"query","name":"group_by","required":false,"schema":{"description":"What a row stands for.","enum":["channel","source","campaign","adset","ad","capture_source","entry_link","whatsapp_number","utm_campaign"],"title":"OriginGroupBy","type":"string","default":"channel","isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>"}},"96a900f5-bacf-4cb5-bad1-a60b5aeff756":{"description":"Which creation date puts a record in the window.","in":"query","name":"date_basis","required":false,"schema":{"enum":["contact_created","deal_created"],"title":"OriginDateBasis","type":"string","default":"contact_created","description":"Which creation date puts a record in the window.","isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>"}},"8fe4afbe-b71c-417d-b9c0-2ea6142a93d1":{"description":"Leave out inferred (backfill), estimated (lookback) and repaired origins. Records without an origin stay in their own row.","in":"query","name":"captured_only","required":false,"schema":{"default":false,"description":"Leave out inferred (backfill), estimated (lookback) and repaired origins. Records without an origin stay in their own row.","title":"Captured Only","type":"boolean","isRequired":false,"uniqueKey":"","typeLabel":"boolean"}},"70c95173-a9c3-43c6-a505-7ca9b7fb68e7":{"in":"query","name":"sort_by","required":false,"schema":{"enum":["contacts","conversations","deals","won_deals","won_value"],"title":"OriginSortBy","type":"string","default":"contacts","isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>"}},"d52ee460-b651-4942-8fde-c988b7c28a4a":{"description":"Top rows kept; the rest are summed into one `other` row.","in":"query","name":"limit","required":false,"schema":{"default":25,"description":"Top rows kept; the rest are summed into one `other` row.","maximum":100,"minimum":1,"title":"Limit","type":"integer","isRequired":false,"uniqueKey":"","typeLabel":"integer"}},"fb01b622-132e-4319-acd4-0d1ff2c0fc09":{"description":"Drill-down parent: a channel row's `key`.","in":"query","name":"channel","required":false,"schema":{"oneOf":[{"type":"string","title":"Channel","description":"Drill-down parent: a channel row's `key`.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Channel","description":"Drill-down parent: a channel row's `key`.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"968e713b-9fe2-4551-bf90-0e9da25531bb":{"description":"Drill-down parent: a source row's `key`.","in":"query","name":"source","required":false,"schema":{"oneOf":[{"type":"string","title":"Source","description":"Drill-down parent: a source row's `key`.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Source","description":"Drill-down parent: a source row's `key`.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"719a15ec-4024-4b4b-a2f8-9d532709c18b":{"description":"Drill-down parent: a campaign row's `key`.","in":"query","name":"campaign","required":false,"schema":{"oneOf":[{"type":"string","title":"Campaign","description":"Drill-down parent: a campaign row's `key`.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Campaign","description":"Drill-down parent: a campaign row's `key`.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"f832dda0-9b6a-4412-9f04-074ee08aac84":{"description":"Drill-down parent: an ad set row's `key`.","in":"query","name":"adset","required":false,"schema":{"oneOf":[{"type":"string","title":"Adset","description":"Drill-down parent: an ad set row's `key`.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Adset","description":"Drill-down parent: an ad set row's `key`.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}}},"responses":{"a0e961ef-eeca-4e03-825e-dbfe29b49dc7":{"content":{"application/json":{"schema":{"properties":{"attribution_rule":{"additionalProperties":{"type":"string","uniqueKey":"attribution_rule.additionalProperties","typeLabel":"string"},"description":"How each count is credited to an origin. Show it next to the numbers.","title":"Attribution Rule","type":"object","isRequired":true,"uniqueKey":"attribution_rule","typeLabel":"Attribution Rule · object"},"captured_only":{"title":"Captured Only","type":"boolean","isRequired":true,"uniqueKey":"captured_only","typeLabel":"boolean"},"date_basis":{"enum":["contact_created","deal_created"],"title":"OriginDateBasis","type":"string","isRequired":true,"uniqueKey":"date_basis","typeLabel":"enum\u003cstring>"},"date_basis_rule":{"additionalProperties":{"type":"string","uniqueKey":"date_basis_rule.additionalProperties","typeLabel":"string"},"title":"Date Basis Rule","type":"object","isRequired":true,"uniqueKey":"date_basis_rule","typeLabel":"Date Basis Rule · object"},"filters":{"additionalProperties":{"type":"string","uniqueKey":"filters.additionalProperties","typeLabel":"string"},"description":"The parent keys the rows are restricted to.","title":"Filters","type":"object","isRequired":true,"uniqueKey":"filters","typeLabel":"Filters · object"},"group_by":{"description":"What a row of the report stands for.\n\n`channel`, `source`, `campaign`, `adset` and `ad` are the levels of a drill-down:\nask for the next level with the parent rows' keys as filters. The other\ngroupings are flat views of the same origins.","enum":["channel","source","campaign","adset","ad","capture_source","entry_link","whatsapp_number","utm_campaign"],"title":"OriginGroupBy","type":"string","isRequired":true,"uniqueKey":"group_by","typeLabel":"enum\u003cstring>"},"limit":{"title":"Limit","type":"integer","isRequired":true,"uniqueKey":"limit","typeLabel":"integer"},"next_group_by":{"oneOf":[{"type":"string","title":"OriginGroupBy","description":"The next level of the drill-down hierarchy; null at the last level and for flat groupings.","enum":["channel","source","campaign","adset","ad","capture_source","entry_link","whatsapp_number","utm_campaign"],"isRequired":true,"uniqueKey":"next_group_by.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The next level of the drill-down hierarchy; null at the last level and for flat groupings.","isRequired":true,"uniqueKey":"next_group_by.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"next_group_by","typeLabel":"enum\u003cstring> | null"},"period":{"properties":{"end":{"description":"Exclusive.","format":"date-time","title":"End","type":"string","isRequired":true,"uniqueKey":"period.end","typeLabel":"string\u003cdate-time>"},"start":{"description":"Inclusive.","format":"date-time","title":"Start","type":"string","isRequired":true,"uniqueKey":"period.start","typeLabel":"string\u003cdate-time>"}},"required":["start","end"],"title":"OriginPeriod","type":"object","isRequired":true,"uniqueKey":"period","typeLabel":"OriginPeriod · object"},"rows":{"description":"At most `limit` origin rows ordered by `sort_by`, then the remainder row, then the unknown row.","items":{"properties":{"contacts":{"title":"Contacts","type":"integer","isRequired":true,"uniqueKey":"rows.items.[INDEX].contacts","typeLabel":"integer"},"conversation_rate":{"oneOf":[{"type":"number","title":"Conversation Rate","description":"Conversations per contact, in percent. Null without contacts.","isRequired":true,"uniqueKey":"rows.items.[INDEX].conversation_rate.oneOf.0","typeLabel":"number"},{"type":"null","title":"Conversation Rate","description":"Conversations per contact, in percent. Null without contacts.","isRequired":true,"uniqueKey":"rows.items.[INDEX].conversation_rate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"rows.items.[INDEX].conversation_rate","typeLabel":"number | null"},"conversations":{"title":"Conversations","type":"integer","isRequired":true,"uniqueKey":"rows.items.[INDEX].conversations","typeLabel":"integer"},"deal_rate":{"oneOf":[{"type":"number","title":"Deal Rate","description":"Deals per contact, in percent. Null without contacts.","isRequired":true,"uniqueKey":"rows.items.[INDEX].deal_rate.oneOf.0","typeLabel":"number"},{"type":"null","title":"Deal Rate","description":"Deals per contact, in percent. Null without contacts.","isRequired":true,"uniqueKey":"rows.items.[INDEX].deal_rate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"rows.items.[INDEX].deal_rate","typeLabel":"number | null"},"deals":{"description":"Deals created.","title":"Deals","type":"integer","isRequired":true,"uniqueKey":"rows.items.[INDEX].deals","typeLabel":"integer"},"deals_value":{"description":"Sum of the value of every deal created, open, won or lost.","title":"Deals Value","type":"number","isRequired":true,"uniqueKey":"rows.items.[INDEX].deals_value","typeLabel":"number"},"drillable":{"description":"True when the next level of the hierarchy can be asked for.","title":"Drillable","type":"boolean","isRequired":true,"uniqueKey":"rows.items.[INDEX].drillable","typeLabel":"boolean"},"key":{"description":"Stable key of the row. Send it back as the parent filter to drill down. `_none` is the bucket of origins that do not carry this dimension (an ad set on a campaign tracked only by UTM); `_unknown` is the record without a recorded origin; `_other` is the remainder row.","title":"Key","type":"string","isRequired":true,"uniqueKey":"rows.items.[INDEX].key","typeLabel":"string"},"kind":{"enum":["origin","other","unknown"],"title":"OriginRowKind","type":"string","isRequired":true,"uniqueKey":"rows.items.[INDEX].kind","typeLabel":"enum\u003cstring>"},"label":{"oneOf":[{"type":"string","title":"Label","description":"Display name when the ad catalog, the UTMs or an entry link carry one. Null for channel, source and capture source (the client translates the key) and for the `unknown` and `other` rows (translate by `kind`).","isRequired":true,"uniqueKey":"rows.items.[INDEX].label.oneOf.0","typeLabel":"string"},{"type":"null","title":"Label","description":"Display name when the ad catalog, the UTMs or an entry link carry one. Null for channel, source and capture source (the client translates the key) and for the `unknown` and `other` rows (translate by `kind`).","isRequired":true,"uniqueKey":"rows.items.[INDEX].label.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"rows.items.[INDEX].label","typeLabel":"string | null"},"win_rate":{"oneOf":[{"type":"number","title":"Win Rate","description":"Won deals per deal created, in percent. Null without deals.","isRequired":true,"uniqueKey":"rows.items.[INDEX].win_rate.oneOf.0","typeLabel":"number"},{"type":"null","title":"Win Rate","description":"Won deals per deal created, in percent. Null without deals.","isRequired":true,"uniqueKey":"rows.items.[INDEX].win_rate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"rows.items.[INDEX].win_rate","typeLabel":"number | null"},"won_deals":{"title":"Won Deals","type":"integer","isRequired":true,"uniqueKey":"rows.items.[INDEX].won_deals","typeLabel":"integer"},"won_per_contact_rate":{"oneOf":[{"type":"number","title":"Won Per Contact Rate","description":"Won deals per contact, in percent. Null without contacts.","isRequired":true,"uniqueKey":"rows.items.[INDEX].won_per_contact_rate.oneOf.0","typeLabel":"number"},{"type":"null","title":"Won Per Contact Rate","description":"Won deals per contact, in percent. Null without contacts.","isRequired":true,"uniqueKey":"rows.items.[INDEX].won_per_contact_rate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"rows.items.[INDEX].won_per_contact_rate","typeLabel":"number | null"},"won_value":{"description":"Sum of the value of the won deals.","title":"Won Value","type":"number","isRequired":true,"uniqueKey":"rows.items.[INDEX].won_value","typeLabel":"number"},"groups":{"oneOf":[{"type":"integer","title":"Groups","description":"On the remainder row: how many groups it sums.","uniqueKey":"rows.items.[INDEX].groups.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Groups","description":"On the remainder row: how many groups it sums.","uniqueKey":"rows.items.[INDEX].groups.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].groups","typeLabel":"integer | null"}},"required":["contacts","conversations","deals","deals_value","won_deals","won_value","conversation_rate","deal_rate","win_rate","won_per_contact_rate","kind","key","label","drillable"],"title":"OriginRow","type":"object","uniqueKey":"rows.items.[INDEX]","typeLabel":"OriginRow · object"},"title":"Rows","type":"array","isRequired":true,"uniqueKey":"rows","typeLabel":"OriginRow · object[]"},"sort_by":{"enum":["contacts","conversations","deals","won_deals","won_value"],"title":"OriginSortBy","type":"string","isRequired":true,"uniqueKey":"sort_by","typeLabel":"enum\u003cstring>"},"totals":{"description":"Every row, the remainder and the unknown row summed.","properties":{"contacts":{"title":"Contacts","type":"integer","isRequired":true,"uniqueKey":"totals.contacts","typeLabel":"integer"},"conversation_rate":{"oneOf":[{"type":"number","title":"Conversation Rate","description":"Conversations per contact, in percent. Null without contacts.","isRequired":true,"uniqueKey":"totals.conversation_rate.oneOf.0","typeLabel":"number"},{"type":"null","title":"Conversation Rate","description":"Conversations per contact, in percent. Null without contacts.","isRequired":true,"uniqueKey":"totals.conversation_rate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"totals.conversation_rate","typeLabel":"number | null"},"conversations":{"title":"Conversations","type":"integer","isRequired":true,"uniqueKey":"totals.conversations","typeLabel":"integer"},"deal_rate":{"oneOf":[{"type":"number","title":"Deal Rate","description":"Deals per contact, in percent. Null without contacts.","isRequired":true,"uniqueKey":"totals.deal_rate.oneOf.0","typeLabel":"number"},{"type":"null","title":"Deal Rate","description":"Deals per contact, in percent. Null without contacts.","isRequired":true,"uniqueKey":"totals.deal_rate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"totals.deal_rate","typeLabel":"number | null"},"deals":{"description":"Deals created.","title":"Deals","type":"integer","isRequired":true,"uniqueKey":"totals.deals","typeLabel":"integer"},"deals_value":{"description":"Sum of the value of every deal created, open, won or lost.","title":"Deals Value","type":"number","isRequired":true,"uniqueKey":"totals.deals_value","typeLabel":"number"},"win_rate":{"oneOf":[{"type":"number","title":"Win Rate","description":"Won deals per deal created, in percent. Null without deals.","isRequired":true,"uniqueKey":"totals.win_rate.oneOf.0","typeLabel":"number"},{"type":"null","title":"Win Rate","description":"Won deals per deal created, in percent. Null without deals.","isRequired":true,"uniqueKey":"totals.win_rate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"totals.win_rate","typeLabel":"number | null"},"won_deals":{"title":"Won Deals","type":"integer","isRequired":true,"uniqueKey":"totals.won_deals","typeLabel":"integer"},"won_per_contact_rate":{"oneOf":[{"type":"number","title":"Won Per Contact Rate","description":"Won deals per contact, in percent. Null without contacts.","isRequired":true,"uniqueKey":"totals.won_per_contact_rate.oneOf.0","typeLabel":"number"},{"type":"null","title":"Won Per Contact Rate","description":"Won deals per contact, in percent. Null without contacts.","isRequired":true,"uniqueKey":"totals.won_per_contact_rate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"totals.won_per_contact_rate","typeLabel":"number | null"},"won_value":{"description":"Sum of the value of the won deals.","title":"Won Value","type":"number","isRequired":true,"uniqueKey":"totals.won_value","typeLabel":"number"}},"required":["contacts","conversations","deals","deals_value","won_deals","won_value","conversation_rate","deal_rate","win_rate","won_per_contact_rate"],"title":"OriginMetrics","type":"object","isRequired":true,"uniqueKey":"totals","typeLabel":"OriginMetrics · object"},"value_rule":{"additionalProperties":{"type":"string","uniqueKey":"value_rule.additionalProperties","typeLabel":"string"},"description":"What won value is and which currency it is in.","title":"Value Rule","type":"object","isRequired":true,"uniqueKey":"value_rule","typeLabel":"Value Rule · object"},"object":{"const":"origin_report","default":"origin_report","title":"Object","type":"string","uniqueKey":"object","typeLabel":"string"}},"required":["period","group_by","next_group_by","date_basis","captured_only","sort_by","limit","filters","attribution_rule","date_basis_rule","value_rule","totals","rows"],"title":"OriginReportResponse","type":"object","uniqueKey":"","typeLabel":"OriginReportResponse · object"},"examples":{"Example":{"title":"Example","value":{"attribution_rule":{},"captured_only":true,"date_basis":"contact_created","date_basis_rule":{},"filters":{},"group_by":"channel","limit":123,"next_group_by":"channel","period":{"end":"2023-11-07T05:31:56Z","start":"2023-11-07T05:31:56Z"},"rows":[{"contacts":123,"conversation_rate":123,"conversations":123,"deal_rate":123,"deals":123,"deals_value":123,"drillable":true,"key":"\u003cstring>","kind":"origin","label":"\u003cstring>","win_rate":123,"won_deals":123,"won_per_contact_rate":123,"won_value":123,"groups":123}],"sort_by":"contacts","totals":{"contacts":123,"conversation_rate":123,"conversations":123,"deal_rate":123,"deals":123,"deals_value":123,"win_rate":123,"won_deals":123,"won_per_contact_rate":123,"won_value":123},"value_rule":{},"object":"origin_report"}}},"exampleType":"generated"}},"description":"Successful Response","headers":{"X-RateLimit-Limit":{"description":"Requests allowed in the current window on this token.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets and the allowance refills.","schema":{"type":"integer"}},"X-Request-ID":{"description":"Unique id for this request. Quote it to support.","schema":{"type":"string"}}},"exampleType":"generated"},"4be10a88-b7a6-4987-b646-8b922d3ce90b":{"content":{"application/json":{"schema":{"description":"Every non-2xx response on the public API has this body.","properties":{"error":{"properties":{"code":{"description":"Stable, machine-readable identifier.","title":"Code","type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"description":"Human-readable explanation.","title":"Message","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"description":"Coarse class of failure. Stable; new codes may appear under a type.","enum":["invalid_request_error","authentication_error","permission_error","not_found_error","conflict_error","rate_limit_error","api_error"],"title":"ErrorType","type":"string","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"detail":{"oneOf":[{"type":"array","items":{"properties":{"field":{"description":"Dotted path to the offending field.","title":"Field","type":"string","isRequired":true,"uniqueKey":"error.detail.oneOf.0.items.[INDEX].field","typeLabel":"string"},"message":{"title":"Message","type":"string","isRequired":true,"uniqueKey":"error.detail.oneOf.0.items.[INDEX].message","typeLabel":"string"},"code":{"oneOf":[{"type":"string","title":"Code","uniqueKey":"error.detail.oneOf.0.items.[INDEX].code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Code","uniqueKey":"error.detail.oneOf.0.items.[INDEX].code.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.detail.oneOf.0.items.[INDEX].code","typeLabel":"string | null"}},"required":["field","message"],"title":"ErrorDetail","type":"object","uniqueKey":"error.detail.oneOf.0.items.[INDEX]","typeLabel":"ErrorDetail · object"},"title":"Detail","description":"Per-field errors for validation failures.","uniqueKey":"error.detail.oneOf.0","typeLabel":"ErrorDetail · object[]"},{"type":"null","title":"Detail","description":"Per-field errors for validation failures.","uniqueKey":"error.detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.detail","typeLabel":"ErrorDetail · object[] | null"},"documentation_url":{"oneOf":[{"type":"string","title":"Documentation Url","uniqueKey":"error.documentation_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Documentation Url","uniqueKey":"error.documentation_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.documentation_url","typeLabel":"string | null"},"param":{"oneOf":[{"type":"string","title":"Param","description":"Request field the error refers to, if any.","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","title":"Param","description":"Request field the error refers to, if any.","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"},"request_id":{"oneOf":[{"type":"string","title":"Request Id","description":"Echoes the X-Request-ID response header. Quote it in support requests.","uniqueKey":"error.request_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Request Id","description":"Echoes the X-Request-ID response header. Quote it in support requests.","uniqueKey":"error.request_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.request_id","typeLabel":"string | null"}},"required":["type","code","message"],"title":"ApiError","type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"ApiError · object"}},"required":["error"],"title":"ApiErrorResponse","type":"object","uniqueKey":"","typeLabel":"ApiErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","type":"invalid_request_error","detail":[{"field":"\u003cstring>","message":"\u003cstring>","code":"\u003cstring>"}],"documentation_url":"\u003cstring>","param":"\u003cstring>","request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"description":"A query parameter, path segment or header is invalid.","headers":{"X-Request-ID":{"description":"Unique id for this request. Quote it to support.","schema":{"type":"string"}}},"exampleType":"generated"},"5f96bdf7-3046-4928-8d3c-2eccd5ed9cdc":{"content":{"application/json":{"schema":{"description":"Every non-2xx response on the public API has this body.","properties":{"error":{"properties":{"code":{"description":"Stable, machine-readable identifier.","title":"Code","type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"description":"Human-readable explanation.","title":"Message","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"description":"Coarse class of failure. Stable; new codes may appear under a type.","enum":["invalid_request_error","authentication_error","permission_error","not_found_error","conflict_error","rate_limit_error","api_error"],"title":"ErrorType","type":"string","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"detail":{"oneOf":[{"type":"array","items":{"properties":{"field":{"description":"Dotted path to the offending field.","title":"Field","type":"string","isRequired":true,"uniqueKey":"error.detail.oneOf.0.items.[INDEX].field","typeLabel":"string"},"message":{"title":"Message","type":"string","isRequired":true,"uniqueKey":"error.detail.oneOf.0.items.[INDEX].message","typeLabel":"string"},"code":{"oneOf":[{"type":"string","title":"Code","uniqueKey":"error.detail.oneOf.0.items.[INDEX].code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Code","uniqueKey":"error.detail.oneOf.0.items.[INDEX].code.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.detail.oneOf.0.items.[INDEX].code","typeLabel":"string | null"}},"required":["field","message"],"title":"ErrorDetail","type":"object","uniqueKey":"error.detail.oneOf.0.items.[INDEX]","typeLabel":"ErrorDetail · object"},"title":"Detail","description":"Per-field errors for validation failures.","uniqueKey":"error.detail.oneOf.0","typeLabel":"ErrorDetail · object[]"},{"type":"null","title":"Detail","description":"Per-field errors for validation failures.","uniqueKey":"error.detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.detail","typeLabel":"ErrorDetail · object[] | null"},"documentation_url":{"oneOf":[{"type":"string","title":"Documentation Url","uniqueKey":"error.documentation_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Documentation Url","uniqueKey":"error.documentation_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.documentation_url","typeLabel":"string | null"},"param":{"oneOf":[{"type":"string","title":"Param","description":"Request field the error refers to, if any.","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","title":"Param","description":"Request field the error refers to, if any.","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"},"request_id":{"oneOf":[{"type":"string","title":"Request Id","description":"Echoes the X-Request-ID response header. Quote it in support requests.","uniqueKey":"error.request_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Request Id","description":"Echoes the X-Request-ID response header. Quote it in support requests.","uniqueKey":"error.request_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.request_id","typeLabel":"string | null"}},"required":["type","code","message"],"title":"ApiError","type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"ApiError · object"}},"required":["error"],"title":"ApiErrorResponse","type":"object","uniqueKey":"","typeLabel":"ApiErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","type":"invalid_request_error","detail":[{"field":"\u003cstring>","message":"\u003cstring>","code":"\u003cstring>"}],"documentation_url":"\u003cstring>","param":"\u003cstring>","request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"description":"The token is missing, unknown, revoked or expired.","headers":{"X-Request-ID":{"description":"Unique id for this request. Quote it to support.","schema":{"type":"string"}}},"exampleType":"generated"},"dbe00e28-729b-4ae4-ae81-2a0f141d4e97":{"content":{"application/json":{"schema":{"description":"Every non-2xx response on the public API has this body.","properties":{"error":{"properties":{"code":{"description":"Stable, machine-readable identifier.","title":"Code","type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"description":"Human-readable explanation.","title":"Message","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"description":"Coarse class of failure. Stable; new codes may appear under a type.","enum":["invalid_request_error","authentication_error","permission_error","not_found_error","conflict_error","rate_limit_error","api_error"],"title":"ErrorType","type":"string","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"detail":{"oneOf":[{"type":"array","items":{"properties":{"field":{"description":"Dotted path to the offending field.","title":"Field","type":"string","isRequired":true,"uniqueKey":"error.detail.oneOf.0.items.[INDEX].field","typeLabel":"string"},"message":{"title":"Message","type":"string","isRequired":true,"uniqueKey":"error.detail.oneOf.0.items.[INDEX].message","typeLabel":"string"},"code":{"oneOf":[{"type":"string","title":"Code","uniqueKey":"error.detail.oneOf.0.items.[INDEX].code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Code","uniqueKey":"error.detail.oneOf.0.items.[INDEX].code.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.detail.oneOf.0.items.[INDEX].code","typeLabel":"string | null"}},"required":["field","message"],"title":"ErrorDetail","type":"object","uniqueKey":"error.detail.oneOf.0.items.[INDEX]","typeLabel":"ErrorDetail · object"},"title":"Detail","description":"Per-field errors for validation failures.","uniqueKey":"error.detail.oneOf.0","typeLabel":"ErrorDetail · object[]"},{"type":"null","title":"Detail","description":"Per-field errors for validation failures.","uniqueKey":"error.detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.detail","typeLabel":"ErrorDetail · object[] | null"},"documentation_url":{"oneOf":[{"type":"string","title":"Documentation Url","uniqueKey":"error.documentation_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Documentation Url","uniqueKey":"error.documentation_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.documentation_url","typeLabel":"string | null"},"param":{"oneOf":[{"type":"string","title":"Param","description":"Request field the error refers to, if any.","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","title":"Param","description":"Request field the error refers to, if any.","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"},"request_id":{"oneOf":[{"type":"string","title":"Request Id","description":"Echoes the X-Request-ID response header. Quote it in support requests.","uniqueKey":"error.request_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Request Id","description":"Echoes the X-Request-ID response header. Quote it in support requests.","uniqueKey":"error.request_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.request_id","typeLabel":"string | null"}},"required":["type","code","message"],"title":"ApiError","type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"ApiError · object"}},"required":["error"],"title":"ApiErrorResponse","type":"object","uniqueKey":"","typeLabel":"ApiErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","type":"invalid_request_error","detail":[{"field":"\u003cstring>","message":"\u003cstring>","code":"\u003cstring>"}],"documentation_url":"\u003cstring>","param":"\u003cstring>","request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"description":"The token lacks a required scope, or the workspace's CRM write policy does not allow this change.","headers":{"X-Request-ID":{"description":"Unique id for this request. Quote it to support.","schema":{"type":"string"}}},"exampleType":"generated"},"18d096a6-0a1d-4f88-aed6-ba84beec7b00":{"content":{"application/json":{"schema":{"description":"Every non-2xx response on the public API has this body.","properties":{"error":{"properties":{"code":{"description":"Stable, machine-readable identifier.","title":"Code","type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"description":"Human-readable explanation.","title":"Message","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"description":"Coarse class of failure. Stable; new codes may appear under a type.","enum":["invalid_request_error","authentication_error","permission_error","not_found_error","conflict_error","rate_limit_error","api_error"],"title":"ErrorType","type":"string","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"detail":{"oneOf":[{"type":"array","items":{"properties":{"field":{"description":"Dotted path to the offending field.","title":"Field","type":"string","isRequired":true,"uniqueKey":"error.detail.oneOf.0.items.[INDEX].field","typeLabel":"string"},"message":{"title":"Message","type":"string","isRequired":true,"uniqueKey":"error.detail.oneOf.0.items.[INDEX].message","typeLabel":"string"},"code":{"oneOf":[{"type":"string","title":"Code","uniqueKey":"error.detail.oneOf.0.items.[INDEX].code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Code","uniqueKey":"error.detail.oneOf.0.items.[INDEX].code.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.detail.oneOf.0.items.[INDEX].code","typeLabel":"string | null"}},"required":["field","message"],"title":"ErrorDetail","type":"object","uniqueKey":"error.detail.oneOf.0.items.[INDEX]","typeLabel":"ErrorDetail · object"},"title":"Detail","description":"Per-field errors for validation failures.","uniqueKey":"error.detail.oneOf.0","typeLabel":"ErrorDetail · object[]"},{"type":"null","title":"Detail","description":"Per-field errors for validation failures.","uniqueKey":"error.detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.detail","typeLabel":"ErrorDetail · object[] | null"},"documentation_url":{"oneOf":[{"type":"string","title":"Documentation Url","uniqueKey":"error.documentation_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Documentation Url","uniqueKey":"error.documentation_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.documentation_url","typeLabel":"string | null"},"param":{"oneOf":[{"type":"string","title":"Param","description":"Request field the error refers to, if any.","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","title":"Param","description":"Request field the error refers to, if any.","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"},"request_id":{"oneOf":[{"type":"string","title":"Request Id","description":"Echoes the X-Request-ID response header. Quote it in support requests.","uniqueKey":"error.request_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Request Id","description":"Echoes the X-Request-ID response header. Quote it in support requests.","uniqueKey":"error.request_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.request_id","typeLabel":"string | null"}},"required":["type","code","message"],"title":"ApiError","type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"ApiError · object"}},"required":["error"],"title":"ApiErrorResponse","type":"object","uniqueKey":"","typeLabel":"ApiErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","type":"invalid_request_error","detail":[{"field":"\u003cstring>","message":"\u003cstring>","code":"\u003cstring>"}],"documentation_url":"\u003cstring>","param":"\u003cstring>","request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"description":"Too many requests on this token. Retry after the delay.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}},"X-RateLimit-Limit":{"description":"Requests allowed in the current window on this token.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets and the allowance refills.","schema":{"type":"integer"}},"X-Request-ID":{"description":"Unique id for this request. Quote it to support.","schema":{"type":"string"}}},"exampleType":"generated"},"9bbec099-37d7-427b-9c97-bae4d5195991":{"content":{"application/json":{"schema":{"description":"Every non-2xx response on the public API has this body.","properties":{"error":{"properties":{"code":{"description":"Stable, machine-readable identifier.","title":"Code","type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"description":"Human-readable explanation.","title":"Message","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"description":"Coarse class of failure. Stable; new codes may appear under a type.","enum":["invalid_request_error","authentication_error","permission_error","not_found_error","conflict_error","rate_limit_error","api_error"],"title":"ErrorType","type":"string","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"detail":{"oneOf":[{"type":"array","items":{"properties":{"field":{"description":"Dotted path to the offending field.","title":"Field","type":"string","isRequired":true,"uniqueKey":"error.detail.oneOf.0.items.[INDEX].field","typeLabel":"string"},"message":{"title":"Message","type":"string","isRequired":true,"uniqueKey":"error.detail.oneOf.0.items.[INDEX].message","typeLabel":"string"},"code":{"oneOf":[{"type":"string","title":"Code","uniqueKey":"error.detail.oneOf.0.items.[INDEX].code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Code","uniqueKey":"error.detail.oneOf.0.items.[INDEX].code.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.detail.oneOf.0.items.[INDEX].code","typeLabel":"string | null"}},"required":["field","message"],"title":"ErrorDetail","type":"object","uniqueKey":"error.detail.oneOf.0.items.[INDEX]","typeLabel":"ErrorDetail · object"},"title":"Detail","description":"Per-field errors for validation failures.","uniqueKey":"error.detail.oneOf.0","typeLabel":"ErrorDetail · object[]"},{"type":"null","title":"Detail","description":"Per-field errors for validation failures.","uniqueKey":"error.detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.detail","typeLabel":"ErrorDetail · object[] | null"},"documentation_url":{"oneOf":[{"type":"string","title":"Documentation Url","uniqueKey":"error.documentation_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Documentation Url","uniqueKey":"error.documentation_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.documentation_url","typeLabel":"string | null"},"param":{"oneOf":[{"type":"string","title":"Param","description":"Request field the error refers to, if any.","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","title":"Param","description":"Request field the error refers to, if any.","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"},"request_id":{"oneOf":[{"type":"string","title":"Request Id","description":"Echoes the X-Request-ID response header. Quote it in support requests.","uniqueKey":"error.request_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Request Id","description":"Echoes the X-Request-ID response header. Quote it in support requests.","uniqueKey":"error.request_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.request_id","typeLabel":"string | null"}},"required":["type","code","message"],"title":"ApiError","type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"ApiError · object"}},"required":["error"],"title":"ApiErrorResponse","type":"object","uniqueKey":"","typeLabel":"ApiErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","type":"invalid_request_error","detail":[{"field":"\u003cstring>","message":"\u003cstring>","code":"\u003cstring>"}],"documentation_url":"\u003cstring>","param":"\u003cstring>","request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"description":"Something went wrong on our side. Quote `error.request_id` to support.","headers":{"X-Request-ID":{"description":"Unique id for this request. Quote it to support.","schema":{"type":"string"}}},"exampleType":"generated"}},"security":{"ebe553ad-a097-48f9-bf9a-88591ac39a7e":{"SailerApiToken":{"description":"A workspace API token (`sk_live_...`) or an OAuth access token (`oat_live_...`). Create workspace tokens in Settings > API. Send either as `Authorization: Bearer \u003ctoken>`.","scheme":"bearer","type":"http","scopes":[],"schemeName":"SailerApiToken"}}},"servers":{"1828cdf7-6641-4742-9f37-e597b7306ad2":{"url":"https://api.chatsailer.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"description":"A workspace API token (`sk_live_...`) or an OAuth access token (`oat_live_...`). Create workspace tokens in Settings > API. Send either as `Authorization: Bearer \u003ctoken>`.","scheme":"bearer","type":"http","scopes":[],"schemeName":"SailerApiToken"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"A workspace API token (`sk_live_...`) or an OAuth access token (`oat_live_...`). Create workspace tokens in Settings > API. Send either as `Authorization: Bearer \u003ctoken>`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"SailerApiToken","name":"Authorization"}],"title":"SailerApiToken"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"sailer-ai","siteName":"Sailer","title":"Origin report - Sailer","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/reports/origin-report","matchLevel":0},"es":{"href":"/api-reference/reports/origin-report","matchLevel":0},"pt-BR":{"href":"/api-reference/reports/origin-report","matchLevel":0}}},"lastModified":"2026-11-02T19:55:46.924Z","originalFileLocation":"api-reference/reports/origin-report.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Contacts, conversations, deals created, deals won and won value per origin, with the ratios between them. Use it to see which channels and campaigns produce revenue, not only volume. group_by picks what a row is. channel → source → campaign → adset → ad is a drill-down: ask for the next level and name the parent rows\u0026#x27; keys in channel, source, campaign and adset. capture_source, entry_link, whatsapp_number and utm_campaign are flat views. Attribution. Each count uses the origin of the record itself: contacts by the contact\u0026#x27;s origin, conversations by the conversation\u0026#x27;s, deals by the deal\u0026#x27;s. The response states the rule in attribution_rule. Records without an origin are one unknown row, never dropped. date_basis is contact_created (a cohort of contacts created in the window) or deal_created (each record by its own creation date). captured_only leaves out origins that were inferred, estimated or repaired. Results are bounded: the top limit rows by sort_by, then one other row for the rest. Only records the token\u0026#x27;s holder may see are counted; a workspace token counts the whole workspace. The window defaults to the 30 days ending now and spans at most 366 days. Needs the contacts:read, deals:read and conversations:read scopes.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Sailer\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/sailer-ai/_OZhzkLcb83uX4ml/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/sailer-ai/_OZhzkLcb83uX4ml/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/sailer-ai/_OZhzkLcb83uX4ml/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/sailer-ai/_OZhzkLcb83uX4ml/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/sailer-ai/_OZhzkLcb83uX4ml/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/sailer-ai/_OZhzkLcb83uX4ml/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/sailer-ai/_OZhzkLcb83uX4ml/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/sailer-ai/_OZhzkLcb83uX4ml/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/sailer-ai/_OZhzkLcb83uX4ml/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Origin report - Sailer\">\u003cmeta data-mint-head property=\"og:description\" content=\"Contacts, conversations, deals created, deals won and won value per origin, with the ratios between them. Use it to see which channels and campaigns produce revenue, not only volume. group_by picks what a row is. channel → source → campaign → adset → ad is a drill-down: ask for the next level and name the parent rows\u0026#x27; keys in channel, source, campaign and adset. capture_source, entry_link, whatsapp_number and utm_campaign are flat views. Attribution. Each count uses the origin of the record itself: contacts by the contact\u0026#x27;s origin, conversations by the conversation\u0026#x27;s, deals by the deal\u0026#x27;s. The response states the rule in attribution_rule. Records without an origin are one unknown row, never dropped. date_basis is contact_created (a cohort of contacts created in the window) or deal_created (each record by its own creation date). captured_only leaves out origins that were inferred, estimated or repaired. Results are bounded: the top limit rows by sort_by, then one other row for the rest. Only records the token\u0026#x27;s holder may see are counted; a workspace token counts the whole workspace. The window defaults to the 30 days ending now and spans at most 366 days. Needs the contacts:read, deals:read and conversations:read scopes.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Sailer\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.chatsailer.com/api-reference/reports/origin-report\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://sailer-ai.mintlify.app/_mintlify/api/og/v2?division=Reports\u0026amp;title=Origin+report\u0026amp;description=Contacts%2C+conversations%2C+deals+created%2C+deals+won+and+won+value+per+origin%2C+with+the+ratios+between+them.+Use+it+to+see+which+channels+and+campaigns+produce+rev\u0026amp;theme=4a0afd472ab2ff243d5ab8cf\u0026amp;signature=c5c03e28412ddd96b200445e5a8c517890da8768ca22e56aa984b117799489fa\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Origin report - Sailer\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Contacts, conversations, deals created, deals won and won value per origin, with the ratios between them. Use it to see which channels and campaigns produce revenue, not only volume. group_by picks what a row is. channel → source → campaign → adset → ad is a drill-down: ask for the next level and name the parent rows\u0026#x27; keys in channel, source, campaign and adset. capture_source, entry_link, whatsapp_number and utm_campaign are flat views. Attribution. Each count uses the origin of the record itself: contacts by the contact\u0026#x27;s origin, conversations by the conversation\u0026#x27;s, deals by the deal\u0026#x27;s. The response states the rule in attribution_rule. Records without an origin are one unknown row, never dropped. date_basis is contact_created (a cohort of contacts created in the window) or deal_created (each record by its own creation date). captured_only leaves out origins that were inferred, estimated or repaired. Results are bounded: the top limit rows by sort_by, then one other row for the rest. Only records the token\u0026#x27;s holder may see are counted; a workspace token counts the whole workspace. The window defaults to the 30 days ending now and spans at most 366 days. Needs the contacts:read, deals:read and conversations:read scopes.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://sailer-ai.mintlify.app/_mintlify/api/og/v2?division=Reports\u0026amp;title=Origin+report\u0026amp;description=Contacts%2C+conversations%2C+deals+created%2C+deals+won+and+won+value+per+origin%2C+with+the+ratios+between+them.+Use+it+to+see+which+channels+and+campaigns+produce+rev\u0026amp;theme=4a0afd472ab2ff243d5ab8cf\u0026amp;signature=c5c03e28412ddd96b200445e5a8c517890da8768ca22e56aa984b117799489fa\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/sailer-ai/_OZhzkLcb83uX4ml/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Sailer\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0EA5E9\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.chatsailer.com/api-reference/reports/origin-report\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/reports/origin-report.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.chatsailer.com/#organization\",\"name\":\"Sailer\",\"url\":\"https://docs.chatsailer.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/sailer-ai/giKWeWjZ5A9lyZTo/logo/light.svg?fit=max\u0026auto=format\u0026n=giKWeWjZ5A9lyZTo\u0026q=85\u0026s=2fab534de473f28a8e631dc6cd6f958a\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.chatsailer.com#website\",\"name\":\"Sailer\",\"url\":\"https://docs.chatsailer.com\",\"publisher\":{\"@id\":\"https://docs.chatsailer.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.chatsailer.com/api-reference/reports/origin-report#webpage\",\"url\":\"https://docs.chatsailer.com/api-reference/reports/origin-report\",\"name\":\"Origin report\",\"description\":\"Contacts, conversations, deals created, deals won and won value per origin, with the ratios between them. Use it to see which channels and campaigns produce revenue, not only volume. group_by picks what a row is. channel → source → campaign → adset → ad is a drill-down: ask for the next level and name the parent rows' keys in channel, source, campaign and adset. capture_source, entry_link, whatsapp_number and utm_campaign are flat views. Attribution. Each count uses the origin of the record itself: contacts by the contact's origin, conversations by the conversation's, deals by the deal's. The response states the rule in attribution_rule. Records without an origin are one unknown row, never dropped. date_basis is contact_created (a cohort of contacts created in the window) or deal_created (each record by its own creation date). captured_only leaves out origins that were inferred, estimated or repaired. Results are bounded: the top limit rows by sort_by, then one other row for the rest. Only records the token's holder may see are counted; a workspace token counts the whole workspace. The window defaults to the 30 days ending now and spans at most 366 days. Needs the contacts:read, deals:read and conversations:read scopes.\",\"dateModified\":\"2026-11-02T19:55:46.924Z\",\"isPartOf\":{\"@id\":\"https://docs.chatsailer.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.chatsailer.com/api-reference/reports/origin-report#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.chatsailer.com/api-reference/reports/origin-report#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Sailer\",\"item\":\"https://docs.chatsailer.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Origin report\",\"item\":\"https://docs.chatsailer.com/api-reference/reports/origin-report\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.chatsailer.com/api-reference/reports/origin-report#apireference\",\"headline\":\"Origin report\",\"name\":\"Origin report\",\"description\":\"Contacts, conversations, deals created, deals won and won value per origin, with the ratios between them. Use it to see which channels and campaigns produce revenue, not only volume. group_by picks what a row is. channel → source → campaign → adset → ad is a drill-down: ask for the next level and name the parent rows' keys in channel, source, campaign and adset. capture_source, entry_link, whatsapp_number and utm_campaign are flat views. Attribution. Each count uses the origin of the record itself: contacts by the contact's origin, conversations by the conversation's, deals by the deal's. The response states the rule in attribution_rule. Records without an origin are one unknown row, never dropped. date_basis is contact_created (a cohort of contacts created in the window) or deal_created (each record by its own creation date). captured_only leaves out origins that were inferred, estimated or repaired. Results are bounded: the top limit rows by sort_by, then one other row for the rest. Only records the token's holder may see are counted; a workspace token counts the whole workspace. The window defaults to the 30 days ending now and spans at most 366 days. Needs the contacts:read, deals:read and conversations:read scopes.\",\"url\":\"https://docs.chatsailer.com/api-reference/reports/origin-report\",\"mainEntityOfPage\":{\"@id\":\"https://docs.chatsailer.com/api-reference/reports/origin-report#webpage\"},\"dateModified\":\"2026-11-02T19:55:46.924Z\",\"publisher\":{\"@id\":\"https://docs.chatsailer.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.chatsailer.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Sailer\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Sailer","nav":{"global":null,"languages":[{"language":"en","default":true,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","groups":[{"group":"Activities","pages":[{"title":"List activities","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/activities","href":"/api-reference/activities/list-activities"},{"title":"Create an activity","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/activities","href":"/api-reference/activities/create-an-activity"},{"title":"Retrieve an activity","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/activities/{activity_id}","href":"/api-reference/activities/retrieve-an-activity"},{"title":"Delete an activity","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/activities/{activity_id}","href":"/api-reference/activities/delete-an-activity"},{"title":"Update an activity","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/activities/{activity_id}","href":"/api-reference/activities/update-an-activity"},{"title":"List activity types","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/activity-types","href":"/api-reference/activities/list-activity-types"}]},{"group":"Audiences","pages":[{"title":"List audiences","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/audiences","href":"/api-reference/audiences/list-audiences"},{"title":"Retrieve an audience","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/audiences/{audience_id}","href":"/api-reference/audiences/retrieve-an-audience"},{"title":"Add contacts to an audience","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/audiences/{audience_id}/members","href":"/api-reference/audiences/add-contacts-to-an-audience"}]},{"group":"Campaigns","pages":[{"title":"List campaigns","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/campaigns","href":"/api-reference/campaigns/list-campaigns"},{"title":"Retrieve a campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/campaigns/{campaign_id}","href":"/api-reference/campaigns/retrieve-a-campaign"},{"title":"List campaign participants","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/campaigns/{campaign_id}/participants","href":"/api-reference/campaigns/list-campaign-participants"},{"title":"Add contacts to a campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/campaigns/{campaign_id}/participants","href":"/api-reference/campaigns/add-contacts-to-a-campaign"},{"title":"Pause a campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/campaigns/{campaign_id}/pause","href":"/api-reference/campaigns/pause-a-campaign"},{"title":"Resume a paused campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/campaigns/{campaign_id}/resume","href":"/api-reference/campaigns/resume-a-paused-campaign"},{"title":"Retrieve campaign stats","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/campaigns/{campaign_id}/stats","href":"/api-reference/campaigns/retrieve-campaign-stats"}]},{"group":"Meta","pages":[{"title":"Effective write policy for this workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/capabilities","href":"/api-reference/meta/effective-write-policy-for-this-workspace"},{"title":"Describe the current token","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/me","href":"/api-reference/meta/describe-the-current-token"}]},{"group":"Channels","pages":[{"title":"List channels","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/channels","href":"/api-reference/channels/list-channels"},{"title":"Retrieve a channel","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/channels/{channel_id}","href":"/api-reference/channels/retrieve-a-channel"}]},{"group":"Contacts","pages":[{"title":"List contacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/contacts","href":"/api-reference/contacts/list-contacts"},{"title":"Create a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/contacts","href":"/api-reference/contacts/create-a-contact"},{"title":"Create or update contacts in bulk","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/contacts/batch","href":"/api-reference/contacts/create-or-update-contacts-in-bulk"},{"title":"Search contacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/contacts/search","href":"/api-reference/contacts/search-contacts"},{"title":"Create or update a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/contacts/upsert","href":"/api-reference/contacts/create-or-update-a-contact"},{"title":"Retrieve a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/contacts/{contact_id}","href":"/api-reference/contacts/retrieve-a-contact"},{"title":"Delete a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/contacts/{contact_id}","href":"/api-reference/contacts/delete-a-contact"},{"title":"Update a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/contacts/{contact_id}","href":"/api-reference/contacts/update-a-contact"}]},{"group":"Conversations","pages":[{"title":"List conversations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/conversations","href":"/api-reference/conversations/list-conversations"},{"title":"Retrieve a conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/conversations/{conversation_id}","href":"/api-reference/conversations/retrieve-a-conversation"},{"title":"Change which teammate handles a conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/conversations/{conversation_id}/assign","href":"/api-reference/conversations/change-which-teammate-handles-a-conversation"},{"title":"Close a conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/conversations/{conversation_id}/close","href":"/api-reference/conversations/close-a-conversation"},{"title":"Hand a conversation from the AI agent to a person","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/conversations/{conversation_id}/handoff","href":"/api-reference/conversations/hand-a-conversation-from-the-ai-agent-to-a-person"},{"title":"List messages in a conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/conversations/{conversation_id}/messages","href":"/api-reference/conversations/list-messages-in-a-conversation"},{"title":"Hand a conversation back to the AI agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/conversations/{conversation_id}/resume-ai","href":"/api-reference/conversations/hand-a-conversation-back-to-the-ai-agent"},{"title":"List AI runs on a conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/conversations/{conversation_id}/runs","href":"/api-reference/conversations/list-ai-runs-on-a-conversation"},{"title":"Retrieve the routing trace for a conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/conversations/{conversation_id}/trace","href":"/api-reference/conversations/retrieve-the-routing-trace-for-a-conversation"}]},{"group":"Deals","pages":[{"title":"List deals","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/deals","href":"/api-reference/deals/list-deals"},{"title":"Create a deal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/deals","href":"/api-reference/deals/create-a-deal"},{"title":"Search deals","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/deals/search","href":"/api-reference/deals/search-deals"},{"title":"Retrieve a deal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/deals/{deal_id}","href":"/api-reference/deals/retrieve-a-deal"},{"title":"Delete a deal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/deals/{deal_id}","href":"/api-reference/deals/delete-a-deal"},{"title":"Update a deal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/deals/{deal_id}","href":"/api-reference/deals/update-a-deal"},{"title":"Move a deal to another stage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/deals/{deal_id}/stage","href":"/api-reference/deals/move-a-deal-to-another-stage"},{"title":"List lost reasons","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/lost-reasons","href":"/api-reference/deals/list-lost-reasons"}]},{"group":"Sync","pages":[{"title":"List deleted records","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/deleted-records","href":"/api-reference/sync/list-deleted-records"}]},{"group":"Fields","pages":[{"title":"List fields","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/fields","href":"/api-reference/fields/list-fields"}]},{"group":"Notes","pages":[{"title":"List notes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/notes","href":"/api-reference/notes/list-notes"},{"title":"Create a note","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/notes","href":"/api-reference/notes/create-a-note"},{"title":"Retrieve a note","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/notes/{note_id}","href":"/api-reference/notes/retrieve-a-note"},{"title":"Delete a note","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/notes/{note_id}","href":"/api-reference/notes/delete-a-note"},{"title":"Update a note","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/notes/{note_id}","href":"/api-reference/notes/update-a-note"}]},{"group":"Organizations","pages":[{"title":"List organizations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/organizations","href":"/api-reference/organizations/list-organizations"},{"title":"Create an organization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/organizations","href":"/api-reference/organizations/create-an-organization"},{"title":"Search organizations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/organizations/search","href":"/api-reference/organizations/search-organizations"},{"title":"Retrieve an organization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/organizations/{organization_id}","href":"/api-reference/organizations/retrieve-an-organization"},{"title":"Delete an organization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/organizations/{organization_id}","href":"/api-reference/organizations/delete-an-organization"},{"title":"Update an organization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/organizations/{organization_id}","href":"/api-reference/organizations/update-an-organization"}]},{"group":"Pipelines","pages":[{"title":"List pipelines","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/pipelines","href":"/api-reference/pipelines/list-pipelines"},{"title":"Retrieve a pipeline","description":"One pipeline with its stages in board order — the same object `GET /v1/pipelines` lists. Use it to check that a stage belongs to a pipeline before creating or moving a deal.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/pipelines/{pipeline_id}","href":"/api-reference/pipelines/retrieve-a-pipeline"}]},{"group":"Reports","pages":[{"title":"Origin report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/reports/origin","href":"/api-reference/reports/origin-report"}]},{"group":"Success Events","pages":[{"title":"List success event types","description":"The kinds of success this workspace can report, ordered by `code`. Send a type's `code` as `event_code` when recording.\n\nRead-only: types are part of the workspace's agreement with Sailer and are set up by Sailer, not through the API.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/success-event-types","href":"/api-reference/success-events/list-success-event-types"},{"title":"List success events","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/success-events","href":"/api-reference/success-events/list-success-events"},{"title":"Record a success event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/success-events","href":"/api-reference/success-events/record-a-success-event"},{"title":"Retrieve a success event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/success-events/{event_id}","href":"/api-reference/success-events/retrieve-a-success-event"},{"title":"Reverse a success event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/success-events/{event_id}/reversal","href":"/api-reference/success-events/reverse-a-success-event"}]},{"group":"Tags","pages":[{"title":"List tags","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tags","href":"/api-reference/tags/list-tags"},{"title":"Create a tag","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/tags","href":"/api-reference/tags/create-a-tag"}]},{"group":"Templates","pages":[{"title":"List templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/templates","href":"/api-reference/templates/list-templates"},{"title":"Retrieve a template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/templates/{template_id}","href":"/api-reference/templates/retrieve-a-template"}]},{"group":"Users","pages":[{"title":"List users","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/users","href":"/api-reference/users/list-users"},{"title":"Retrieve a user","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/users/{user_id}","href":"/api-reference/users/retrieve-a-user"}]}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/mcp/overview"}]}]},{"language":"es","navbar":{"links":[{"href":"https://mysailer.com","label":"Producto"}],"primary":{"type":"button","label":"Habla con nosotros","href":"mailto:support@mysailer.com"}},"tabs":[{"tab":"Guías","pages":[{"title":"Guías","href":"/es"}]},{"tab":"Referencia de la API","groups":[{"group":"Activities","pages":[{"title":"List activities","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/activities","href":"/api-reference/activities/list-activities"},{"title":"Create an activity","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/activities","href":"/api-reference/activities/create-an-activity"},{"title":"Retrieve an activity","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/activities/{activity_id}","href":"/api-reference/activities/retrieve-an-activity"},{"title":"Delete an activity","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/activities/{activity_id}","href":"/api-reference/activities/delete-an-activity"},{"title":"Update an activity","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/activities/{activity_id}","href":"/api-reference/activities/update-an-activity"},{"title":"List activity types","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/activity-types","href":"/api-reference/activities/list-activity-types"}]},{"group":"Audiences","pages":[{"title":"List audiences","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/audiences","href":"/api-reference/audiences/list-audiences"},{"title":"Retrieve an audience","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/audiences/{audience_id}","href":"/api-reference/audiences/retrieve-an-audience"},{"title":"Add contacts to an audience","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/audiences/{audience_id}/members","href":"/api-reference/audiences/add-contacts-to-an-audience"}]},{"group":"Campaigns","pages":[{"title":"List campaigns","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/campaigns","href":"/api-reference/campaigns/list-campaigns"},{"title":"Retrieve a campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/campaigns/{campaign_id}","href":"/api-reference/campaigns/retrieve-a-campaign"},{"title":"List campaign participants","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/campaigns/{campaign_id}/participants","href":"/api-reference/campaigns/list-campaign-participants"},{"title":"Add contacts to a campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/campaigns/{campaign_id}/participants","href":"/api-reference/campaigns/add-contacts-to-a-campaign"},{"title":"Pause a campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/campaigns/{campaign_id}/pause","href":"/api-reference/campaigns/pause-a-campaign"},{"title":"Resume a paused campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/campaigns/{campaign_id}/resume","href":"/api-reference/campaigns/resume-a-paused-campaign"},{"title":"Retrieve campaign stats","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/campaigns/{campaign_id}/stats","href":"/api-reference/campaigns/retrieve-campaign-stats"}]},{"group":"Meta","pages":[{"title":"Effective write policy for this workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/capabilities","href":"/api-reference/meta/effective-write-policy-for-this-workspace"},{"title":"Describe the current token","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/me","href":"/api-reference/meta/describe-the-current-token"}]},{"group":"Channels","pages":[{"title":"List channels","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/channels","href":"/api-reference/channels/list-channels"},{"title":"Retrieve a channel","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/channels/{channel_id}","href":"/api-reference/channels/retrieve-a-channel"}]},{"group":"Contacts","pages":[{"title":"List contacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/contacts","href":"/api-reference/contacts/list-contacts"},{"title":"Create a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/contacts","href":"/api-reference/contacts/create-a-contact"},{"title":"Create or update contacts in bulk","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/contacts/batch","href":"/api-reference/contacts/create-or-update-contacts-in-bulk"},{"title":"Search contacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/contacts/search","href":"/api-reference/contacts/search-contacts"},{"title":"Create or update a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/contacts/upsert","href":"/api-reference/contacts/create-or-update-a-contact"},{"title":"Retrieve a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/contacts/{contact_id}","href":"/api-reference/contacts/retrieve-a-contact"},{"title":"Delete a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/contacts/{contact_id}","href":"/api-reference/contacts/delete-a-contact"},{"title":"Update a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/contacts/{contact_id}","href":"/api-reference/contacts/update-a-contact"}]},{"group":"Conversations","pages":[{"title":"List conversations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/conversations","href":"/api-reference/conversations/list-conversations"},{"title":"Retrieve a conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/conversations/{conversation_id}","href":"/api-reference/conversations/retrieve-a-conversation"},{"title":"Change which teammate handles a conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/conversations/{conversation_id}/assign","href":"/api-reference/conversations/change-which-teammate-handles-a-conversation"},{"title":"Close a conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/conversations/{conversation_id}/close","href":"/api-reference/conversations/close-a-conversation"},{"title":"Hand a conversation from the AI agent to a person","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/conversations/{conversation_id}/handoff","href":"/api-reference/conversations/hand-a-conversation-from-the-ai-agent-to-a-person"},{"title":"List messages in a conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/conversations/{conversation_id}/messages","href":"/api-reference/conversations/list-messages-in-a-conversation"},{"title":"Hand a conversation back to the AI agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/conversations/{conversation_id}/resume-ai","href":"/api-reference/conversations/hand-a-conversation-back-to-the-ai-agent"},{"title":"List AI runs on a conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/conversations/{conversation_id}/runs","href":"/api-reference/conversations/list-ai-runs-on-a-conversation"},{"title":"Retrieve the routing trace for a conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/conversations/{conversation_id}/trace","href":"/api-reference/conversations/retrieve-the-routing-trace-for-a-conversation"}]},{"group":"Deals","pages":[{"title":"List deals","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/deals","href":"/api-reference/deals/list-deals"},{"title":"Create a deal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/deals","href":"/api-reference/deals/create-a-deal"},{"title":"Search deals","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/deals/search","href":"/api-reference/deals/search-deals"},{"title":"Retrieve a deal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/deals/{deal_id}","href":"/api-reference/deals/retrieve-a-deal"},{"title":"Delete a deal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/deals/{deal_id}","href":"/api-reference/deals/delete-a-deal"},{"title":"Update a deal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/deals/{deal_id}","href":"/api-reference/deals/update-a-deal"},{"title":"Move a deal to another stage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/deals/{deal_id}/stage","href":"/api-reference/deals/move-a-deal-to-another-stage"},{"title":"List lost reasons","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/lost-reasons","href":"/api-reference/deals/list-lost-reasons"}]},{"group":"Sync","pages":[{"title":"List deleted records","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/deleted-records","href":"/api-reference/sync/list-deleted-records"}]},{"group":"Fields","pages":[{"title":"List fields","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/fields","href":"/api-reference/fields/list-fields"}]},{"group":"Notes","pages":[{"title":"List notes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/notes","href":"/api-reference/notes/list-notes"},{"title":"Create a note","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/notes","href":"/api-reference/notes/create-a-note"},{"title":"Retrieve a note","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/notes/{note_id}","href":"/api-reference/notes/retrieve-a-note"},{"title":"Delete a note","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/notes/{note_id}","href":"/api-reference/notes/delete-a-note"},{"title":"Update a note","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/notes/{note_id}","href":"/api-reference/notes/update-a-note"}]},{"group":"Organizations","pages":[{"title":"List organizations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/organizations","href":"/api-reference/organizations/list-organizations"},{"title":"Create an organization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/organizations","href":"/api-reference/organizations/create-an-organization"},{"title":"Search organizations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/organizations/search","href":"/api-reference/organizations/search-organizations"},{"title":"Retrieve an organization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/organizations/{organization_id}","href":"/api-reference/organizations/retrieve-an-organization"},{"title":"Delete an organization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/organizations/{organization_id}","href":"/api-reference/organizations/delete-an-organization"},{"title":"Update an organization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/organizations/{organization_id}","href":"/api-reference/organizations/update-an-organization"}]},{"group":"Pipelines","pages":[{"title":"List pipelines","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/pipelines","href":"/api-reference/pipelines/list-pipelines"},{"title":"Retrieve a pipeline","description":"One pipeline with its stages in board order — the same object `GET /v1/pipelines` lists. Use it to check that a stage belongs to a pipeline before creating or moving a deal.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/pipelines/{pipeline_id}","href":"/api-reference/pipelines/retrieve-a-pipeline"}]},{"group":"Reports","pages":[{"title":"Origin report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/reports/origin","href":"/api-reference/reports/origin-report"}]},{"group":"Success Events","pages":[{"title":"List success event types","description":"The kinds of success this workspace can report, ordered by `code`. Send a type's `code` as `event_code` when recording.\n\nRead-only: types are part of the workspace's agreement with Sailer and are set up by Sailer, not through the API.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/success-event-types","href":"/api-reference/success-events/list-success-event-types"},{"title":"List success events","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/success-events","href":"/api-reference/success-events/list-success-events"},{"title":"Record a success event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/success-events","href":"/api-reference/success-events/record-a-success-event"},{"title":"Retrieve a success event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/success-events/{event_id}","href":"/api-reference/success-events/retrieve-a-success-event"},{"title":"Reverse a success event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/success-events/{event_id}/reversal","href":"/api-reference/success-events/reverse-a-success-event"}]},{"group":"Tags","pages":[{"title":"List tags","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tags","href":"/api-reference/tags/list-tags"},{"title":"Create a tag","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/tags","href":"/api-reference/tags/create-a-tag"}]},{"group":"Templates","pages":[{"title":"List templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/templates","href":"/api-reference/templates/list-templates"},{"title":"Retrieve a template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/templates/{template_id}","href":"/api-reference/templates/retrieve-a-template"}]},{"group":"Users","pages":[{"title":"List users","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/users","href":"/api-reference/users/list-users"},{"title":"Retrieve a user","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/users/{user_id}","href":"/api-reference/users/retrieve-a-user"}]}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/es/mcp/overview"}]}]},{"language":"pt-BR","navbar":{"links":[{"href":"https://mysailer.com","label":"Produto"}],"primary":{"type":"button","label":"Fale conosco","href":"mailto:support@mysailer.com"}},"tabs":[{"tab":"Guias","pages":[{"title":"Guias","href":"/pt-BR"}]},{"tab":"Referência da API","groups":[{"group":"Activities","pages":[{"title":"List activities","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/activities","href":"/api-reference/activities/list-activities"},{"title":"Create an activity","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/activities","href":"/api-reference/activities/create-an-activity"},{"title":"Retrieve an activity","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/activities/{activity_id}","href":"/api-reference/activities/retrieve-an-activity"},{"title":"Delete an activity","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/activities/{activity_id}","href":"/api-reference/activities/delete-an-activity"},{"title":"Update an activity","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/activities/{activity_id}","href":"/api-reference/activities/update-an-activity"},{"title":"List activity types","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/activity-types","href":"/api-reference/activities/list-activity-types"}]},{"group":"Audiences","pages":[{"title":"List audiences","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/audiences","href":"/api-reference/audiences/list-audiences"},{"title":"Retrieve an audience","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/audiences/{audience_id}","href":"/api-reference/audiences/retrieve-an-audience"},{"title":"Add contacts to an audience","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/audiences/{audience_id}/members","href":"/api-reference/audiences/add-contacts-to-an-audience"}]},{"group":"Campaigns","pages":[{"title":"List campaigns","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/campaigns","href":"/api-reference/campaigns/list-campaigns"},{"title":"Retrieve a campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/campaigns/{campaign_id}","href":"/api-reference/campaigns/retrieve-a-campaign"},{"title":"List campaign participants","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/campaigns/{campaign_id}/participants","href":"/api-reference/campaigns/list-campaign-participants"},{"title":"Add contacts to a campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/campaigns/{campaign_id}/participants","href":"/api-reference/campaigns/add-contacts-to-a-campaign"},{"title":"Pause a campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/campaigns/{campaign_id}/pause","href":"/api-reference/campaigns/pause-a-campaign"},{"title":"Resume a paused campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/campaigns/{campaign_id}/resume","href":"/api-reference/campaigns/resume-a-paused-campaign"},{"title":"Retrieve campaign stats","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/campaigns/{campaign_id}/stats","href":"/api-reference/campaigns/retrieve-campaign-stats"}]},{"group":"Meta","pages":[{"title":"Effective write policy for this workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/capabilities","href":"/api-reference/meta/effective-write-policy-for-this-workspace"},{"title":"Describe the current token","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/me","href":"/api-reference/meta/describe-the-current-token"}]},{"group":"Channels","pages":[{"title":"List channels","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/channels","href":"/api-reference/channels/list-channels"},{"title":"Retrieve a channel","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/channels/{channel_id}","href":"/api-reference/channels/retrieve-a-channel"}]},{"group":"Contacts","pages":[{"title":"List contacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/contacts","href":"/api-reference/contacts/list-contacts"},{"title":"Create a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/contacts","href":"/api-reference/contacts/create-a-contact"},{"title":"Create or update contacts in bulk","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/contacts/batch","href":"/api-reference/contacts/create-or-update-contacts-in-bulk"},{"title":"Search contacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/contacts/search","href":"/api-reference/contacts/search-contacts"},{"title":"Create or update a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/contacts/upsert","href":"/api-reference/contacts/create-or-update-a-contact"},{"title":"Retrieve a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/contacts/{contact_id}","href":"/api-reference/contacts/retrieve-a-contact"},{"title":"Delete a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/contacts/{contact_id}","href":"/api-reference/contacts/delete-a-contact"},{"title":"Update a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/contacts/{contact_id}","href":"/api-reference/contacts/update-a-contact"}]},{"group":"Conversations","pages":[{"title":"List conversations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/conversations","href":"/api-reference/conversations/list-conversations"},{"title":"Retrieve a conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/conversations/{conversation_id}","href":"/api-reference/conversations/retrieve-a-conversation"},{"title":"Change which teammate handles a conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/conversations/{conversation_id}/assign","href":"/api-reference/conversations/change-which-teammate-handles-a-conversation"},{"title":"Close a conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/conversations/{conversation_id}/close","href":"/api-reference/conversations/close-a-conversation"},{"title":"Hand a conversation from the AI agent to a person","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/conversations/{conversation_id}/handoff","href":"/api-reference/conversations/hand-a-conversation-from-the-ai-agent-to-a-person"},{"title":"List messages in a conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/conversations/{conversation_id}/messages","href":"/api-reference/conversations/list-messages-in-a-conversation"},{"title":"Hand a conversation back to the AI agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/conversations/{conversation_id}/resume-ai","href":"/api-reference/conversations/hand-a-conversation-back-to-the-ai-agent"},{"title":"List AI runs on a conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/conversations/{conversation_id}/runs","href":"/api-reference/conversations/list-ai-runs-on-a-conversation"},{"title":"Retrieve the routing trace for a conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/conversations/{conversation_id}/trace","href":"/api-reference/conversations/retrieve-the-routing-trace-for-a-conversation"}]},{"group":"Deals","pages":[{"title":"List deals","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/deals","href":"/api-reference/deals/list-deals"},{"title":"Create a deal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/deals","href":"/api-reference/deals/create-a-deal"},{"title":"Search deals","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/deals/search","href":"/api-reference/deals/search-deals"},{"title":"Retrieve a deal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/deals/{deal_id}","href":"/api-reference/deals/retrieve-a-deal"},{"title":"Delete a deal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/deals/{deal_id}","href":"/api-reference/deals/delete-a-deal"},{"title":"Update a deal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/deals/{deal_id}","href":"/api-reference/deals/update-a-deal"},{"title":"Move a deal to another stage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/deals/{deal_id}/stage","href":"/api-reference/deals/move-a-deal-to-another-stage"},{"title":"List lost reasons","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/lost-reasons","href":"/api-reference/deals/list-lost-reasons"}]},{"group":"Sync","pages":[{"title":"List deleted records","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/deleted-records","href":"/api-reference/sync/list-deleted-records"}]},{"group":"Fields","pages":[{"title":"List fields","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/fields","href":"/api-reference/fields/list-fields"}]},{"group":"Notes","pages":[{"title":"List notes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/notes","href":"/api-reference/notes/list-notes"},{"title":"Create a note","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/notes","href":"/api-reference/notes/create-a-note"},{"title":"Retrieve a note","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/notes/{note_id}","href":"/api-reference/notes/retrieve-a-note"},{"title":"Delete a note","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/notes/{note_id}","href":"/api-reference/notes/delete-a-note"},{"title":"Update a note","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/notes/{note_id}","href":"/api-reference/notes/update-a-note"}]},{"group":"Organizations","pages":[{"title":"List organizations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/organizations","href":"/api-reference/organizations/list-organizations"},{"title":"Create an organization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/organizations","href":"/api-reference/organizations/create-an-organization"},{"title":"Search organizations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/organizations/search","href":"/api-reference/organizations/search-organizations"},{"title":"Retrieve an organization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/organizations/{organization_id}","href":"/api-reference/organizations/retrieve-an-organization"},{"title":"Delete an organization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/organizations/{organization_id}","href":"/api-reference/organizations/delete-an-organization"},{"title":"Update an organization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/organizations/{organization_id}","href":"/api-reference/organizations/update-an-organization"}]},{"group":"Pipelines","pages":[{"title":"List pipelines","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/pipelines","href":"/api-reference/pipelines/list-pipelines"},{"title":"Retrieve a pipeline","description":"One pipeline with its stages in board order — the same object `GET /v1/pipelines` lists. Use it to check that a stage belongs to a pipeline before creating or moving a deal.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/pipelines/{pipeline_id}","href":"/api-reference/pipelines/retrieve-a-pipeline"}]},{"group":"Reports","pages":[{"title":"Origin report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/reports/origin","href":"/api-reference/reports/origin-report"}]},{"group":"Success Events","pages":[{"title":"List success event types","description":"The kinds of success this workspace can report, ordered by `code`. Send a type's `code` as `event_code` when recording.\n\nRead-only: types are part of the workspace's agreement with Sailer and are set up by Sailer, not through the API.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/success-event-types","href":"/api-reference/success-events/list-success-event-types"},{"title":"List success events","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/success-events","href":"/api-reference/success-events/list-success-events"},{"title":"Record a success event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/success-events","href":"/api-reference/success-events/record-a-success-event"},{"title":"Retrieve a success event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/success-events/{event_id}","href":"/api-reference/success-events/retrieve-a-success-event"},{"title":"Reverse a success event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/success-events/{event_id}/reversal","href":"/api-reference/success-events/reverse-a-success-event"}]},{"group":"Tags","pages":[{"title":"List tags","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tags","href":"/api-reference/tags/list-tags"},{"title":"Create a tag","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/tags","href":"/api-reference/tags/create-a-tag"}]},{"group":"Templates","pages":[{"title":"List templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/templates","href":"/api-reference/templates/list-templates"},{"title":"Retrieve a template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/templates/{template_id}","href":"/api-reference/templates/retrieve-a-template"}]},{"group":"Users","pages":[{"title":"List users","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/users","href":"/api-reference/users/list-users"},{"title":"Retrieve a user","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/users/{user_id}","href":"/api-reference/users/retrieve-a-user"}]}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/pt-BR/mcp/overview"}]}]}]},"basePath":"","title":"Origin report - Sailer","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DCDCdBVX.js","utils-ME8dDnLe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-0e84ACsd.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-wgRBj-ia.js","snippetPresets-C11Sgb-o.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.js","Page-Bevw23-4.js","getPastedJson-u6QiPzNZ.js","icon-Bb-CBSxO.js","MethodPill-F7l5AI7V.js","DuplicateIcon-IiAXkdSg.js","createIcon-FliI8EBc.js","DynamicMarkdown-B62XqCSI.js","SectionHeading-Dj31pT03.js","axios-vUo_bRtp.js","Markdown-BOgQCTwD.js","clsx-BIWXJmsZ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DKZWslLH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-UDqbR6xh.js"]}