Use the Authorization header with the value 'Bearer ' to authenticate. Partner API Keys have full access; Project API Keys are limited to their project scope. Learn more: https://docs.peaka.com/api-reference/authentication
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Peaka","colors":{"primary":"#5F62F0","light":"#9EA0F6","dark":"#4547A9"},"logo":{"light":"https://mintcdn.com/peaka/KTMImw3DJs9xEUBv/logo/light.svg?fit=max\u0026auto=format\u0026n=KTMImw3DJs9xEUBv\u0026q=85\u0026s=52dc065c1b2905abbf7573ee7d418d24","dark":"https://mintcdn.com/peaka/KTMImw3DJs9xEUBv/logo/dark.svg?fit=max\u0026auto=format\u0026n=KTMImw3DJs9xEUBv\u0026q=85\u0026s=892325d9142c524be9621683aeaa0729","href":"https://www.peaka.com/"},"favicon":"https://mintcdn.com/peaka/f3Y42yDBmWmxwbQG/favicon.svg?fit=max\u0026auto=format\u0026n=f3Y42yDBmWmxwbQG\u0026q=85\u0026s=9aa5087cad74cf5817aa4d27a7d57b4f","api":{"mdx":{"auth":{"method":"bearer"}}},"navbar":{"links":[{"href":"mailto:support@peaka.com","label":"Support"}],"primary":{"type":"button","label":"Peaka Studio","href":"https://peaka.studio"}},"footer":{"socials":{"twitter":"https://twitter.com/peakacom","github":"https://github.com/peakacom","linkedin":"https://www.linkedin.com/company/peaka"}},"integrations":{"gtm":{"tagId":"GTM-NLBSKN8"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Documentation","icon":"book-open-cover","href":"https://docs.peaka.com"},{"anchor":"Community","icon":"discord","href":"https://www.peaka.com/community"},{"anchor":"Blog","icon":"newspaper","href":"https://www.peaka.com/blog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"peaka","hasAudioNarration":false,"actualSubdomain":"peaka","customDomains":["docs.peaka.com"],"gitSource":{"type":"github","owner":"peakacom","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a820ff466c3c6b3957773ca","collectionId":"0ebdacb1-6a78-4664-abe7-a8e46465cb0a","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6a820ff466c3c6b3957773ca"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6a820ff466c3c6b3957773ca:success","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"API Reference","count":141},{"language":"default","tag":"Data -- Metadata","count":22},{"language":"default","tag":"Data -- Internal Tables","count":16},{"language":"default","tag":"Data -- Cache","count":14},{"language":"default","tag":"Data -- Catalogs","count":11},{"language":"default","tag":"Connections","count":9},{"language":"default","tag":"Data -- Query Folders","count":9},{"language":"default","tag":"AI -- AgentV2","count":7},{"language":"default","tag":"Data -- Queries","count":7},{"language":"default","tag":"Data -- Exports","count":5}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/data--queries/execute-query","slug":"/api-reference/data--queries/execute-query","pageMetadata":{"openapi":"post /data/projects/{projectId}/queries/execute","title":"Execute Query","description":"Executes a query and returns the result. Accepts a query builder object, a query ID, a query name, or a raw SQL statement.\n\nThe **`format`** query parameter controls the shape of the `data` array in the response:\n\n| Value | Description |\n|-------|-------------|\n| `CELL_TYPED` *(default)* | Each cell is an object with `name`, `displayName`, `dataType`, `order`, and `value`. |\n| `SIMPLE` | Each row is a flat JSON object whose keys are the column names. |\n| `COMPACT` | Each row is a plain array of values ordered by column position. |\n","href":"/api-reference/data--queries/execute-query"},"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 em: \"em\",\n p: \"p\",\n strong: \"strong\",\n table: \"table\",\n tbody: \"tbody\",\n td: \"td\",\n th: \"th\",\n thead: \"thead\",\n tr: \"tr\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Executes a query and returns the result. Accepts a query builder object, a query ID, a query name, or a raw SQL statement.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"The \", _jsx(_components.strong, {\n children: _jsx(_components.code, {\n children: \"format\"\n })\n }), \" query parameter controls the shape of the \", _jsx(_components.code, {\n children: \"data\"\n }), \" array in the response:\"]\n }), \"\\n\", _jsxs(_components.table, {\n children: [_jsx(_components.thead, {\n children: _jsxs(_components.tr, {\n children: [_jsx(_components.th, {\n children: \"Value\"\n }), _jsx(_components.th, {\n children: \"Description\"\n })]\n })\n }), _jsxs(_components.tbody, {\n children: [_jsxs(_components.tr, {\n children: [_jsxs(_components.td, {\n children: [_jsx(_components.code, {\n children: \"CELL_TYPED\"\n }), \" \", _jsx(_components.em, {\n children: \"(default)\"\n })]\n }), _jsxs(_components.td, {\n children: [\"Each cell is an object with \", _jsx(_components.code, {\n children: \"name\"\n }), \", \", _jsx(_components.code, {\n children: \"displayName\"\n }), \", \", _jsx(_components.code, {\n children: \"dataType\"\n }), \", \", _jsx(_components.code, {\n children: \"order\"\n }), \", and \", _jsx(_components.code, {\n children: \"value\"\n }), \".\"]\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"SIMPLE\"\n })\n }), _jsx(_components.td, {\n children: \"Each row is a flat JSON object whose keys are the column names.\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"COMPACT\"\n })\n }), _jsx(_components.td, {\n children: \"Each row is a plain array of values ordered by column position.\"\n })]\n })]\n })]\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{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const{OptimizedImage}={..._provideComponents(),...props.components};if(!OptimizedImage)_missingMdxReference(`OptimizedImage`,true);return _jsxs(`span`,{style:{display:`flex`,gap:`10px`,flexDirection:`row`,alignItems:`center`},children:[_jsx(OptimizedImage,{src:`https://cdn.peaka.com/badges/partner-api-key-badge.png`}),_jsx(OptimizedImage,{src:`https://cdn.peaka.com/badges/project-api-key-badge.png`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"post /data/projects/{projectId}/queries/execute","title":"Execute Query","description":"Executes a query and returns the result. Accepts a query builder object, a query ID, a query name, or a raw SQL statement.\n\nThe **`format`** query parameter controls the shape of the `data` array in the response:\n\n| Value | Description |\n|-------|-------------|\n| `CELL_TYPED` *(default)* | Each cell is an object with `name`, `displayName`, `dataType`, `order`, and `value`. |\n| `SIMPLE` | Each row is a flat JSON object whose keys are the column names. |\n| `COMPACT` | Each row is a plain array of values ordered by column position. |\n","href":"/api-reference/data--queries/execute-query"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Data -- Queries"],"summary":"Execute Query","description":"Executes a query and returns the result. Accepts a query builder object, a query ID, a query name, or a raw SQL statement.\n\nThe **`format`** query parameter controls the shape of the `data` array in the response:\n\n| Value | Description |\n|-------|-------------|\n| `CELL_TYPED` *(default)* | Each cell is an object with `name`, `displayName`, `dataType`, `order`, and `value`. |\n| `SIMPLE` | Each row is a flat JSON object whose keys are the column names. |\n| `COMPACT` | Each row is a plain array of values ordered by column position. |\n","operationId":"executeQuery","parameters":["7656d1a7-b45e-4d13-a6fe-0c92ac986e5c","d2c41981-ceeb-47fa-85f0-d0923f13349a"],"requestBody":"7038f055-5390-4c95-8144-b060e558054c","responses":{"200":"beb5d0c6-4fd6-46ab-a4db-b1dd1be03898"},"x-mint":{"content":"\u003cspan style={{display: \"flex\", gap: \"10px\", flexDirection: \"row\", alignItems: \"center\"}}>\n \u003cimg src=\"https://cdn.peaka.com/badges/partner-api-key-badge.png\"/>\n \u003cimg src=\"https://cdn.peaka.com/badges/project-api-key-badge.png\"/>\n\u003c/span>\n"},"method":"post","type":"path","servers":["181c24df-89f5-4cfe-8f0b-36e17c398120","b93b5877-b3ef-471f-abea-12f7d493129c"],"security":["7a217ce3-af7b-4fac-8a59-cf29d84410c9"],"path":"/data/projects/{projectId}/queries/execute","baseUrlOptions":["https://partner.peaka.studio/api/v1","https://partner.eu.peaka.studio/api/v1"],"title":"Execute Query","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"7656d1a7-b45e-4d13-a6fe-0c92ac986e5c":{"name":"projectId","in":"path","description":"ID of the Project","required":true,"schema":{"type":"string","isRequired":true,"description":"ID of the Project","uniqueKey":"","typeLabel":"string"},"example":"mtKDhe1U"},"d2c41981-ceeb-47fa-85f0-d0923f13349a":{"name":"format","in":"query","description":"Response format: CELL_TYPED (default), SIMPLE, or COMPACT","required":false,"schema":{"type":"string","default":"CELL_TYPED","enum":["CELL_TYPED","SIMPLE","COMPACT"],"isRequired":false,"description":"Response format: CELL_TYPED (default), SIMPLE, or COMPACT","uniqueKey":"","typeLabel":"enum\u003cstring>"},"example":"SIMPLE"}},"requestBody":{"description":"Execute Query Request","content":{"application/json":{"schema":{"oneOf":[{"type":"object","description":"Executes a query using the query builder. The \u003ccode>from\u003c/code> field is required.\n\n \u003cp>Minimal example:\n \u003cpre>\n {\n \"from\": [\n {\n \"catalogName\": \"peaka\",\n \"schemaName\": \"query\",\n \"tableName\": \"samplequery\"\n }\n ]\n }\n \u003c/pre>\n\n \u003cp>With columns, filters, limit, offset, and orderBy:\n \u003cpre>\n {\n \"columns\": [\"amount\"],\n \"from\": [\n {\n \"catalogName\": \"wilderman_green\",\n \"schemaName\": \"payment\",\n \"tableName\": \"charges\"\n }\n ],\n \"filters\": {\n \"and\": [\n [\n { \"column\": { \"catalogName\": \"wilderman_green\", \"schemaName\": \"payment\", \"tableName\": \"charges\", \"columnName\": \"amount\" } },\n \">\",\n [150]\n ]\n ]\n },\n \"limit\": 50,\n \"offset\": 0,\n \"orderBy\": [\"amount DESC\"]\n }\n \u003c/pre>","properties":{"columns":{"type":"array","description":"Columns to select. If omitted, all columns (\u003ccode>*\u003c/code>) are returned.","items":{"type":"string","uniqueKey":"oneOf.0.columns.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.0.columns","typeLabel":"string[]"},"from":{"type":"array","description":"Tables to query from. At least one entry is required.","items":{"type":"object","properties":{"catalogId":{"type":"string","uniqueKey":"oneOf.0.from.items.[INDEX].catalogId","typeLabel":"string"},"catalogName":{"type":"string","uniqueKey":"oneOf.0.from.items.[INDEX].catalogName","typeLabel":"string"},"schemaName":{"type":"string","uniqueKey":"oneOf.0.from.items.[INDEX].schemaName","typeLabel":"string"},"tableName":{"type":"string","uniqueKey":"oneOf.0.from.items.[INDEX].tableName","typeLabel":"string"}},"uniqueKey":"oneOf.0.from.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.from","typeLabel":"object[]"},"limit":{"type":"integer","description":"Maximum number of rows to return.","format":"int64","uniqueKey":"oneOf.0.limit","typeLabel":"integer\u003cint64>"},"offset":{"type":"integer","description":"Number of rows to skip before returning results.","format":"int64","uniqueKey":"oneOf.0.offset","typeLabel":"integer\u003cint64>"},"orderBy":{"type":"array","description":"Ordering specifications. Each entry is a column name optionally followed by \u003ccode>ASC\u003c/code> or \u003ccode>DESC\u003c/code>.\n Example: \u003ccode>[\u0026quot;amount DESC\u0026quot;, \u0026quot;created_at ASC\u0026quot;]\u003c/code>.","items":{"type":"string","uniqueKey":"oneOf.0.orderBy.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.0.orderBy","typeLabel":"string[]"},"filters":{"type":"object","additionalProperties":true,"description":"Filter conditions. Supports \u003ccode>and\u003c/code>/\u003ccode>or\u003c/code> logic with column comparisons.","uniqueKey":"oneOf.0.filters","typeLabel":"object"},"timeout":{"type":"integer","description":"Query timeout in seconds.","format":"int32","uniqueKey":"oneOf.0.timeout","typeLabel":"integer\u003cint32>"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","description":"Executes a query by its ID.\n\n \u003cpre>\n {\n \"id\": \"709922802836177297\"\n\n }\n \u003c/pre>","properties":{"id":{"type":"string","description":"The ID of the query to execute.","uniqueKey":"oneOf.1.id","typeLabel":"string"},"timeout":{"type":"integer","description":"Query timeout in seconds.","format":"int32","uniqueKey":"oneOf.1.timeout","typeLabel":"integer\u003cint32>"}},"uniqueKey":"oneOf.1","typeLabel":"object"},{"type":"object","description":"Executes a query by its fully qualified name in the format \u003ccode>\u0026lt;catalogName\u0026gt;.\u0026lt;schemaName\u0026gt;.\u0026lt;tableName\u0026gt;\u003c/code>.\n\n \u003cpre>\n {\"qualifiedName\": \"peaka.query.samplequery\"}\n \u003c/pre>","properties":{"qualifiedName":{"type":"string","description":"Fully qualified name of the query, e.g.\n \u003ccode>peaka.query.samplequery\u003c/code> or\n \u003ccode>peaka.mtquery.samplequery\u003c/code> or\n \u003ccode>stripe.payment.charges\u003c/code>","uniqueKey":"oneOf.2.qualifiedName","typeLabel":"string"},"timeout":{"type":"integer","description":"Query timeout in seconds.","format":"int32","uniqueKey":"oneOf.2.timeout","typeLabel":"integer\u003cint32>"}},"uniqueKey":"oneOf.2","typeLabel":"object"},{"type":"object","description":"Executes a raw SQL statement directly via the queries/execute endpoint.\n\n \u003cpre>\n {\n \"statement\": \"SELECT * FROM \\\"peaka\\\".\\\"query\\\".\\\"samplequery\\\"\",\n \"bindArgs\": [\"arg1\", \"arg2\"]\n }\n \u003c/pre>","properties":{"statement":{"type":"string","description":"The SQL statement to execute.","uniqueKey":"oneOf.3.statement","typeLabel":"string"},"bindings":{"type":"array","description":"Optional bind arguments for parameterised queries.","items":{"type":"string","uniqueKey":"oneOf.3.bindings.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.3.bindings","typeLabel":"string[]"},"timeout":{"type":"integer","description":"Query timeout in seconds.","format":"int32","uniqueKey":"oneOf.3.timeout","typeLabel":"integer\u003cint32>"}},"uniqueKey":"oneOf.3","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Execute by Query Builder":{"title":"Execute by Query Builder","description":"Execute by Query Builder","value":{"from":[{"catalogName":"peaka","schemaName":"query","tableName":"samplequery"}]}},"Execute by Query Builder with Limit":{"title":"Execute by Query Builder with Limit","description":"Execute by Query Builder with Limit","value":{"columns":["amount"],"from":[{"catalogName":"peaka","schemaName":"query","tableName":"samplequery"}],"filters":null,"limit":3,"offset":0,"orderBy":null}},"Execute by Query Builder with Filter and Order By":{"title":"Execute by Query Builder with Filter and Order By","description":"Execute by Query Builder with Filter and Order By","value":{"columns":["amount"],"from":[{"catalogName":"wilderman_green","schemaName":"payment","tableName":"charges"}],"filters":{"and":[[{"column":{"catalogName":"wilderman_green","schemaName":"payment","tableName":"charges","columnName":"amount"}},">",[150]]]},"limit":50,"offset":0,"orderBy":["amount DESC"]}},"Execute by Query ID":{"title":"Execute by Query ID","description":"Execute by Query ID","value":{"id":"709922802836177297"}},"Execute by Query Name":{"title":"Execute by Query Name","description":"Execute by Query Name","value":{"qualifiedName":"peaka.query.samplequery"}},"Execute by SQL Statement":{"title":"Execute by SQL Statement","description":"Execute by SQL Statement","value":{"statement":"SELECT * FROM \"peaka\".\"query\".\"samplequery\""}}},"exampleType":"examples"}},"required":true,"exampleType":"examples"},"responses":{"beb5d0c6-4fd6-46ab-a4db-b1dd1be03898":{"description":"Query Result","content":{"application/json":{"examples":{"CELL_TYPED (default)":{"title":"CELL_TYPED (default)","description":"CELL_TYPED (default)","value":{"columns":[{"catalogName":"peaka","schemaName":"query","tableName":"samplequery","columnName":"event"},{"catalogName":"peaka","schemaName":"query","tableName":"samplequery","columnName":"distinct_id"}],"data":[[{"name":"event","displayName":"event","dataType":"varchar","order":0,"value":"$mp_web_page_view"},{"name":"distinct_id","displayName":"distinct_id","dataType":"varchar","order":1,"value":"$device:916806fd-8a6c-425b-b5f9-b76b5d6f9d55"}]]}},"SIMPLE":{"title":"SIMPLE","description":"SIMPLE","value":{"columns":[{"catalogName":"peaka","schemaName":"query","tableName":"samplequery","columnName":"event"},{"catalogName":"peaka","schemaName":"query","tableName":"samplequery","columnName":"distinct_id"}],"data":[{"event":"$mp_web_page_view","distinct_id":"$device:916806fd-8a6c-425b-b5f9-b76b5d6f9d55"}]}},"COMPACT":{"title":"COMPACT","description":"COMPACT","value":{"columns":[{"catalogName":"peaka","schemaName":"query","tableName":"samplequery","columnName":"event"},{"catalogName":"peaka","schemaName":"query","tableName":"samplequery","columnName":"distinct_id"}],"data":[["$mp_web_page_view","$device:916806fd-8a6c-425b-b5f9-b76b5d6f9d55"]]}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"7a217ce3-af7b-4fac-8a59-cf29d84410c9":{"bearerAuth":{"type":"http","description":"Use the Authorization header with the value 'Bearer \u003capiKey>' to authenticate. Partner API Keys have full access; Project API Keys are limited to their project scope. Learn more: https://docs.peaka.com/api-reference/authentication","scheme":"bearer","bearerFormat":"Api Key","scopes":[]}}},"servers":{"181c24df-89f5-4cfe-8f0b-36e17c398120":{"url":"https://partner.peaka.studio/api/v1","description":"Default Server URL (US Zone)"},"b93b5877-b3ef-471f-abea-12f7d493129c":{"url":"https://partner.eu.peaka.studio/api/v1","description":"EU Zone"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","description":"Use the Authorization header with the value 'Bearer \u003capiKey>' to authenticate. Partner API Keys have full access; Project API Keys are limited to their project scope. Learn more: https://docs.peaka.com/api-reference/authentication","scheme":"bearer","bearerFormat":"Api Key","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Use the Authorization header with the value 'Bearer \u003capiKey>' to authenticate. Partner API Keys have full access; Project API Keys are limited to their project scope. Learn more: https://docs.peaka.com/api-reference/authentication","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/peaka-openapi.json"},"subdomain":"peaka","siteName":"Peaka","title":"Execute Query - Peaka","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-03-27T14:37:49.689Z","originalFileLocation":"api-reference/data--queries/execute-query.mdx"},"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=\"Executes a query and returns the result. Accepts a query builder object, a query ID, a query name, or a raw SQL statement. The format query parameter controls the shape of the data array in the response: | Value | Description | |-------|-------------| | CELL_TYPED (default) | Each cell is an object with name, displayName, dataType, order, and value. | | SIMPLE | Each row is a flat JSON object whose keys are the column names. | | COMPACT | Each row is a plain array of values ordered by column position. |\">\u003cmeta data-mint-head name=\"application-name\" content=\"Peaka\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/peaka/Xvkixmw2HjtZz8lo/_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/peaka/Xvkixmw2HjtZz8lo/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/peaka/Xvkixmw2HjtZz8lo/_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/peaka/Xvkixmw2HjtZz8lo/_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/peaka/Xvkixmw2HjtZz8lo/_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/peaka/Xvkixmw2HjtZz8lo/_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/peaka/Xvkixmw2HjtZz8lo/_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/peaka/Xvkixmw2HjtZz8lo/_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/peaka/Xvkixmw2HjtZz8lo/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Execute Query - Peaka\">\u003cmeta data-mint-head property=\"og:description\" content=\"Executes a query and returns the result. Accepts a query builder object, a query ID, a query name, or a raw SQL statement. The format query parameter controls the shape of the data array in the response: | Value | Description | |-------|-------------| | CELL_TYPED (default) | Each cell is an object with name, displayName, dataType, order, and value. | | SIMPLE | Each row is a flat JSON object whose keys are the column names. | | COMPACT | Each row is a plain array of values ordered by column position. |\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Peaka\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.peaka.com/api-reference/data--queries/execute-query\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://peaka.mintlify.app/_mintlify/api/og/v2?division=Data+--+Queries\u0026amp;title=Execute+Query\u0026amp;description=Executes+a+query+and+returns+the+result.+Accepts+a+query+builder+object%2C+a+query+ID%2C+a+query+name%2C+or+a+raw+SQL+statement.%0A%0AThe+**%60format%60**+query+parameter+con\u0026amp;theme=31de81707d28b482cfe06788\u0026amp;signature=eef4a949a3c61c62d16bd8c17bef69eb4e5ed2815606cd6d8dd7afc3618c901b\">\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=\"Execute Query - Peaka\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Executes a query and returns the result. Accepts a query builder object, a query ID, a query name, or a raw SQL statement. The format query parameter controls the shape of the data array in the response: | Value | Description | |-------|-------------| | CELL_TYPED (default) | Each cell is an object with name, displayName, dataType, order, and value. | | SIMPLE | Each row is a flat JSON object whose keys are the column names. | | COMPACT | Each row is a plain array of values ordered by column position. |\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://peaka.mintlify.app/_mintlify/api/og/v2?division=Data+--+Queries\u0026amp;title=Execute+Query\u0026amp;description=Executes+a+query+and+returns+the+result.+Accepts+a+query+builder+object%2C+a+query+ID%2C+a+query+name%2C+or+a+raw+SQL+statement.%0A%0AThe+**%60format%60**+query+parameter+con\u0026amp;theme=31de81707d28b482cfe06788\u0026amp;signature=eef4a949a3c61c62d16bd8c17bef69eb4e5ed2815606cd6d8dd7afc3618c901b\">\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/peaka/Xvkixmw2HjtZz8lo/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Peaka\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#5F62F0\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.peaka.com/api-reference/data--queries/execute-query\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/data--queries/execute-query.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.peaka.com/#organization\",\"name\":\"Peaka\",\"url\":\"https://docs.peaka.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/peaka/KTMImw3DJs9xEUBv/logo/light.svg?fit=max\u0026auto=format\u0026n=KTMImw3DJs9xEUBv\u0026q=85\u0026s=52dc065c1b2905abbf7573ee7d418d24\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.peaka.com#website\",\"name\":\"Peaka\",\"url\":\"https://docs.peaka.com\",\"publisher\":{\"@id\":\"https://docs.peaka.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.peaka.com/api-reference/data--queries/execute-query#webpage\",\"url\":\"https://docs.peaka.com/api-reference/data--queries/execute-query\",\"name\":\"Execute Query\",\"description\":\"Executes a query and returns the result. Accepts a query builder object, a query ID, a query name, or a raw SQL statement. The format query parameter controls the shape of the data array in the response: | Value | Description | |-------|-------------| | CELL_TYPED (default) | Each cell is an object with name, displayName, dataType, order, and value. | | SIMPLE | Each row is a flat JSON object whose keys are the column names. | | COMPACT | Each row is a plain array of values ordered by column position. |\",\"dateModified\":\"2026-03-27T14:37:49.689Z\",\"isPartOf\":{\"@id\":\"https://docs.peaka.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.peaka.com/api-reference/data--queries/execute-query#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.peaka.com/api-reference/data--queries/execute-query#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Data -- Queries\",\"item\":\"https://docs.peaka.com/api-reference/data--queries/list-queries\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Execute Query\",\"item\":\"https://docs.peaka.com/api-reference/data--queries/execute-query\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.peaka.com/api-reference/data--queries/execute-query#apireference\",\"headline\":\"Execute Query\",\"name\":\"Execute Query\",\"description\":\"Executes a query and returns the result. Accepts a query builder object, a query ID, a query name, or a raw SQL statement. The format query parameter controls the shape of the data array in the response: | Value | Description | |-------|-------------| | CELL_TYPED (default) | Each cell is an object with name, displayName, dataType, order, and value. | | SIMPLE | Each row is a flat JSON object whose keys are the column names. | | COMPACT | Each row is a plain array of values ordered by column position. |\",\"url\":\"https://docs.peaka.com/api-reference/data--queries/execute-query\",\"mainEntityOfPage\":{\"@id\":\"https://docs.peaka.com/api-reference/data--queries/execute-query#webpage\"},\"dateModified\":\"2026-03-27T14:37:49.689Z\",\"publisher\":{\"@id\":\"https://docs.peaka.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.peaka.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Peaka\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Peaka","nav":{"global":{"anchors":[{"anchor":"Documentation","icon":"book-open-cover","href":"https://docs.peaka.com"},{"anchor":"Community","icon":"discord","href":"https://www.peaka.com/community"},{"anchor":"Blog","icon":"newspaper","href":"https://www.peaka.com/blog"}]},"tabs":[{"tab":"Documentation","href":"https://www.peaka.com/docs/introduction"},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Servers","href":"/api-reference/servers"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Structure","href":"/api-reference/structure"}]},{"group":"Organization -- Organizations","pages":[{"openapi":"get /organizations","title":"List Organizations","href":"/api-reference/organization--organizations/list-organizations"},{"openapi":"get /organizations/{organizationId}","title":"Read Organization","href":"/api-reference/organization--organizations/read-organization"}]},{"group":"Organization -- Workspaces","pages":[{"openapi":"get /organizations/{organizationId}/workspaces","title":"List Workspaces","href":"/api-reference/organization--workspaces/list-workspaces"},{"openapi":"post /organizations/{organizationId}/workspaces","title":"Create Workspace","href":"/api-reference/organization--workspaces/create-workspace"},{"openapi":"get /organizations/{organizationId}/workspaces/{workspaceId}","title":"Read Workspace","href":"/api-reference/organization--workspaces/read-workspace"},{"openapi":"put /organizations/{organizationId}/workspaces/{workspaceId}","title":"Update Workspace","href":"/api-reference/organization--workspaces/update-workspace"},{"openapi":"delete /organizations/{organizationId}/workspaces/{workspaceId}","title":"Delete Workspace","href":"/api-reference/organization--workspaces/delete-workspace"}]},{"group":"Organization -- Projects","pages":[{"openapi":"get /organizations/{organizationId}/workspaces/{workspaceId}/projects","title":"List Projects","href":"/api-reference/organization--projects/list-projects"},{"openapi":"post /organizations/{organizationId}/workspaces/{workspaceId}/projects","title":"Create Project","href":"/api-reference/organization--projects/create-project"},{"openapi":"get /organizations/{organizationId}/workspaces/{workspaceId}/projects/{projectId}","title":"Read Project","href":"/api-reference/organization--projects/read-project"},{"openapi":"put /organizations/{organizationId}/workspaces/{workspaceId}/projects/{projectId}","title":"Update Project","href":"/api-reference/organization--projects/update-project"},{"openapi":"delete /organizations/{organizationId}/workspaces/{workspaceId}/projects/{projectId}","title":"Delete Project","href":"/api-reference/organization--projects/delete-project"}]},{"group":"Projects (Deprecated)","pages":[{"openapi":"get /projects","deprecated":true,"title":"List Projects","href":"/api-reference/projects-deprecated/list-projects"},{"openapi":"post /projects","deprecated":true,"title":"Create Project","href":"/api-reference/projects-deprecated/create-project"},{"openapi":"get /projects/{projectId}","deprecated":true,"title":"Read Project","href":"/api-reference/projects-deprecated/read-project"},{"openapi":"put /projects/{projectId}","deprecated":true,"title":"Update Project","href":"/api-reference/projects-deprecated/update-project"},{"openapi":"delete /projects/{projectId}","deprecated":true,"title":"Delete Project","href":"/api-reference/projects-deprecated/delete-project"}]},{"group":"Projects -- Api Key","pages":[{"openapi":"get /projects/{projectId}/apiKeys","title":"List API Keys","href":"/api-reference/projects--api-key/list-api-keys"},{"openapi":"post /projects/{projectId}/apiKeys","title":"Create API Key","href":"/api-reference/projects--api-key/create-api-key"},{"openapi":"delete /projects/{projectId}/apiKeys/{apiKeyId}","title":"Delete API Key","href":"/api-reference/projects--api-key/delete-api-key"}]},{"group":"Connections","pages":[{"openapi":"get /connections/config","title":"List Connection Config","href":"/api-reference/connections/list-connection-config"},{"openapi":"get /connections/config/{connectionType}","title":"Get Connection Config","href":"/api-reference/connections/get-connection-config"},{"openapi":"get /connections/{projectId}","title":"List Connections","href":"/api-reference/connections/list-connections"},{"openapi":"post /connections/{projectId}","title":"Create Connection","href":"/api-reference/connections/create-connection"},{"openapi":"post /connections/{projectId}/oauth2","title":"Oauth2 Callback","href":"/api-reference/connections/oauth2-callback"},{"openapi":"get /connections/{projectId}/{connectionId}","title":"Get Connection","href":"/api-reference/connections/get-connection"},{"openapi":"put /connections/{projectId}/{connectionId}","title":"Update Connection","href":"/api-reference/connections/update-connection"},{"openapi":"delete /connections/{projectId}/{connectionId}","title":"Delete Connection","href":"/api-reference/connections/delete-connection"},{"openapi":"get /connections/{projectId}/{connectionId}/detail","title":"Get Connection Detail","href":"/api-reference/connections/get-connection-detail"}]},{"group":"Data -- Catalogs","pages":[{"openapi":"get /data/projects/{projectId}/catalogs","title":"List Catalogs","href":"/api-reference/data--catalogs/list-catalogs"},{"openapi":"post /data/projects/{projectId}/catalogs","title":"Create Catalog","href":"/api-reference/data--catalogs/create-catalog"},{"openapi":"get /data/projects/{projectId}/catalogs/{catalogId}","title":"Read Catalog","href":"/api-reference/data--catalogs/read-catalog"},{"openapi":"delete /data/projects/{projectId}/catalogs/{catalogId}","title":"Delete Catalog","href":"/api-reference/data--catalogs/delete-catalog"},{"openapi":"get /data/projects/{projectId}/catalogs/{catalogId}/schemas","title":"List Schemas","href":"/api-reference/data--catalogs/list-schemas"},{"openapi":"get /data/projects/{projectId}/catalogs/{catalogId}/schemas/{schemaName}/tables","title":"List Tables","href":"/api-reference/data--catalogs/list-tables"},{"openapi":"get /data/projects/{projectId}/catalogs/{catalogId}/schemas/{schemaName}/tables/{tableName}/columns","title":"List Columns","href":"/api-reference/data--catalogs/list-columns"},{"openapi":"get /data/projects/{projectId}/catalogs/{catalogId}/schemas/{schemaName}/tables/{tableName}/isCached","title":"Table is Cached","href":"/api-reference/data--catalogs/table-is-cached"},{"openapi":"get /data/projects/{projectId}/catalogs/{catalogId}/schemas/{schemaName}/tables/{tableName}/statistics","title":"Table Statistics","href":"/api-reference/data--catalogs/table-statistics"},{"openapi":"post /data/projects/{projectId}/catalogs/{catalogId}/share","title":"Share Catalog","href":"/api-reference/data--catalogs/share-catalog"},{"openapi":"post /data/projects/{projectId}/search","title":"Search","href":"/api-reference/data--catalogs/search"}]},{"group":"Data -- Internal Tables","pages":[{"openapi":"get /data/projects/{projectId}/bitable","title":"List BI Tables","href":"/api-reference/data--internal-tables/list-bi-tables"},{"openapi":"post /data/projects/{projectId}/bitable/{tableName}","title":"Create BI Table","href":"/api-reference/data--internal-tables/create-bi-table"},{"openapi":"delete /data/projects/{projectId}/bitable/{tableName}","title":"Delete BI Table","href":"/api-reference/data--internal-tables/delete-bi-table"},{"openapi":"get /data/projects/{projectId}/bitable/{tableName}/columns","title":"List BI Columns","href":"/api-reference/data--internal-tables/list-bi-columns"},{"openapi":"post /data/projects/{projectId}/bitable/{tableName}/columns","title":"Add BI Column","href":"/api-reference/data--internal-tables/add-bi-column"},{"openapi":"put /data/projects/{projectId}/bitable/{tableName}/columns/{columnName}","title":"Update BI Column","href":"/api-reference/data--internal-tables/update-bi-column"},{"openapi":"delete /data/projects/{projectId}/bitable/{tableName}/columns/{columnName}","title":"Delete BI Column","href":"/api-reference/data--internal-tables/delete-bi-column"},{"openapi":"get /data/projects/{projectId}/table","title":"List Tables","href":"/api-reference/data--internal-tables/list-tables"},{"openapi":"post /data/projects/{projectId}/table/{tableName}","title":"Create Table","href":"/api-reference/data--internal-tables/create-table"},{"openapi":"delete /data/projects/{projectId}/table/{tableName}","title":"Delete Table","href":"/api-reference/data--internal-tables/delete-table"},{"openapi":"get /data/projects/{projectId}/table/{tableName}/columns","title":"List Columns","href":"/api-reference/data--internal-tables/list-columns"},{"openapi":"post /data/projects/{projectId}/table/{tableName}/columns","title":"Add Column","href":"/api-reference/data--internal-tables/add-column"},{"openapi":"put /data/projects/{projectId}/table/{tableName}/columns/{columnName}","title":"Update Column","href":"/api-reference/data--internal-tables/update-column"},{"openapi":"delete /data/projects/{projectId}/table/{tableName}/columns/{columnName}","title":"Delete Column","href":"/api-reference/data--internal-tables/delete-column"},{"openapi":"post /data/projects/{projectId}/table/{tableName}/import","title":"Import CSV","href":"/api-reference/data--internal-tables/import-csv"},{"openapi":"get /data/projects/{projectId}/table/{tableName}/sample","title":"Get Sample CSV","href":"/api-reference/data--internal-tables/get-sample-csv"}]},{"group":"Data -- Queries","pages":[{"openapi":"get /data/projects/{projectId}/queries","title":"List Queries","href":"/api-reference/data--queries/list-queries"},{"openapi":"post /data/projects/{projectId}/queries","title":"Create Query","description":"Creates a new query under the given project. Supports plain and materialized query types. Optionally accepts a path to place the query in a folder hierarchy. A MATERIALIZED query is materialized immediately on create and its result is queryable as `\"peaka\".\"mtquery\".\"\u003cname>\"`; an optional `schedule` keeps it refreshed. To materialize an existing query, send `inputQueryRefId` with the source query's id instead of `inputQuery`: a snapshot of the source SQL is taken at create time and stored as the new query's own `inputQuery` (the source query is left untouched, and later changes to it do not propagate).","href":"/api-reference/data--queries/create-query"},{"openapi":"post /data/projects/{projectId}/queries/execute","title":"Execute Query","href":"/api-reference/data--queries/execute-query"},{"openapi":"get /data/projects/{projectId}/queries/{queryId}","title":"Read Query","description":"Returns a single query by its ID. Includes path and folderId if the query is placed in a folder.","href":"/api-reference/data--queries/read-query"},{"openapi":"put /data/projects/{projectId}/queries/{queryId}","title":"Update Query","href":"/api-reference/data--queries/update-query"},{"openapi":"delete /data/projects/{projectId}/queries/{queryId}","title":"Delete Query","href":"/api-reference/data--queries/delete-query"},{"openapi":"patch /data/projects/{projectId}/queries/{queryId}/path","title":"Update Query Path","href":"/api-reference/data--queries/update-query-path"}]},{"group":"Data -- Query Folders","pages":[{"openapi":"get /data/projects/{projectId}/queries/folders","title":"List Query Folders","href":"/api-reference/data--query-folders/list-query-folders"},{"openapi":"post /data/projects/{projectId}/queries/folders","title":"Create Query Folder","href":"/api-reference/data--query-folders/create-query-folder"},{"openapi":"get /data/projects/{projectId}/queries/folders/tree","title":"Get Query Folder Tree","href":"/api-reference/data--query-folders/get-query-folder-tree"},{"openapi":"get /data/projects/{projectId}/queries/folders/{folderId}","title":"Read Query Folder","href":"/api-reference/data--query-folders/read-query-folder"},{"openapi":"put /data/projects/{projectId}/queries/folders/{folderId}","title":"Add/Remove Queries In/From Folder","href":"/api-reference/data--query-folders/addremove-queries-infrom-folder"},{"openapi":"delete /data/projects/{projectId}/queries/folders/{folderId}","title":"Delete Query Folder","href":"/api-reference/data--query-folders/delete-query-folder"},{"openapi":"patch /data/projects/{projectId}/queries/folders/{folderId}/name","title":"Rename Query Folder","href":"/api-reference/data--query-folders/rename-query-folder"},{"openapi":"patch /data/projects/{projectId}/queries/folders/{folderId}/path","title":"Move Query Folder","href":"/api-reference/data--query-folders/move-query-folder"},{"openapi":"post /data/projects/{projectId}/queries/folders/{parentFolderId}","title":"Create Query Folder Under Parent","href":"/api-reference/data--query-folders/create-query-folder-under-parent"}]},{"group":"Data -- Semantic Catalogs","pages":[{"openapi":"post /data/projects/{projectId}/semantic-catalogs","title":"Create a semantic catalog","href":"/api-reference/data--semantic-catalogs/create-a-semantic-catalog"},{"openapi":"post /data/projects/{projectId}/semantic-catalogs/{catalogId}","title":"Create a semantic table","href":"/api-reference/data--semantic-catalogs/create-a-semantic-table"},{"openapi":"post /data/projects/{projectId}/semantic-catalogs/{catalogId}/share","title":"Share Semantic Catalog","href":"/api-reference/data--semantic-catalogs/share-semantic-catalog"},{"openapi":"delete /data/projects/{projectId}/semantic-catalogs/{catalogId}/table/{tableId}","title":"Delete a semantic table","href":"/api-reference/data--semantic-catalogs/delete-a-semantic-table"}]},{"group":"Data -- Cache","pages":[{"openapi":"post /data/projects/{projectId}/cache","title":"Create Cache","href":"/api-reference/data--cache/create-cache"},{"openapi":"post /data/projects/{projectId}/cache/batch","title":"Create Batch Cache","href":"/api-reference/data--cache/create-batch-cache"},{"openapi":"get /data/projects/{projectId}/cache/status","title":"Get All Cache Statuses of a Project","href":"/api-reference/data--cache/get-all-cache-statuses-of-a-project"},{"openapi":"get /data/projects/{projectId}/cache/{cacheId}","title":"Get Cache Settings","href":"/api-reference/data--cache/get-cache-settings"},{"openapi":"put /data/projects/{projectId}/cache/{cacheId}","title":"Update Cache Settings","href":"/api-reference/data--cache/update-cache-settings"},{"openapi":"delete /data/projects/{projectId}/cache/{cacheId}","title":"Delete Cache","href":"/api-reference/data--cache/delete-cache"},{"openapi":"post /data/projects/{projectId}/cache/{cacheId}/cancelFullRefreshUpdate","title":"Cancel Running Full Refresh","href":"/api-reference/data--cache/cancel-running-full-refresh"},{"openapi":"post /data/projects/{projectId}/cache/{cacheId}/cancelIncrementalUpdate","title":"Cancel Running Incremental Update","href":"/api-reference/data--cache/cancel-running-incremental-update"},{"openapi":"get /data/projects/{projectId}/cache/{cacheId}/executionHistory","title":"Get Cache Execution History","href":"/api-reference/data--cache/get-cache-execution-history"},{"openapi":"post /data/projects/{projectId}/cache/{cacheId}/fullRefreshUpdate","title":"Trigger Full Refresh Cache Update","href":"/api-reference/data--cache/trigger-full-refresh-cache-update"},{"openapi":"post /data/projects/{projectId}/cache/{cacheId}/incrementalUpdate","title":"Trigger Incremental Cache Update","href":"/api-reference/data--cache/trigger-incremental-cache-update"},{"openapi":"get /data/projects/{projectId}/cache/{cacheId}/status","title":"Get Cache Status","href":"/api-reference/data--cache/get-cache-status"},{"openapi":"get /data/projects/{projectId}/catalog/{catalogId}/cache/status","title":"Get All Cache Statuses of a Catalog","href":"/api-reference/data--cache/get-all-cache-statuses-of-a-catalog"},{"openapi":"get /data/projects/{projectId}/catalog/{catalogId}/schema/{schemaName}/cache/status","title":"Get All Cache Statuses of a Schema","href":"/api-reference/data--cache/get-all-cache-statuses-of-a-schema"}]},{"group":"Data -- Exports","pages":[{"openapi":"post /data/projects/{projectId}/queries/{queryId}/exports","title":"Export Query (async)","href":"/api-reference/data--exports/export-query-async"},{"openapi":"post /data/projects/{projectId}/catalogs/{catalogId}/schemas/{schemaName}/tables/{tableName}/exports","title":"Export Table (async)","href":"/api-reference/data--exports/export-table-async"},{"openapi":"get /data/projects/{projectId}/exports","title":"List Exports","href":"/api-reference/data--exports/list-exports"},{"openapi":"get /data/projects/{projectId}/exports/{exportId}","title":"Read Export","href":"/api-reference/data--exports/read-export"},{"openapi":"delete /data/projects/{projectId}/exports/{exportId}","title":"Cancel Export","href":"/api-reference/data--exports/cancel-export"}]},{"group":"Data -- Parametric Tables","pages":[{"openapi":"get /data/projects/{projectId}/catalogs/{catalogId}/parametricTables","title":"List Parametric Tables","href":"/api-reference/data--parametric-tables/list-parametric-tables"},{"openapi":"post /data/projects/{projectId}/catalogs/{catalogId}/parametricTables","title":"Create Parametric Table","href":"/api-reference/data--parametric-tables/create-parametric-table"},{"openapi":"delete /data/projects/{projectId}/catalogs/{catalogId}/parametricTables","title":"Delete Parametric Table","href":"/api-reference/data--parametric-tables/delete-parametric-table"}]},{"group":"Embedded Peaka Api","pages":[{"openapi":"get /ui/initSession","deprecated":true,"title":"Init Session (Deprecated)","href":"/api-reference/embedded-peaka-api/init-session-deprecated"},{"openapi":"post /ui/initSession","title":"Init Session","href":"/api-reference/embedded-peaka-api/init-session"}]},{"group":"Supported Drivers","pages":[{"openapi":"get /supportedDrivers","title":"List Supported Drivers","href":"/api-reference/supported-drivers/list-supported-drivers"},{"openapi":"get /supportedDrivers/jdbc","title":"Get JDBC Driver","href":"/api-reference/supported-drivers/get-jdbc-driver"},{"openapi":"get /supportedDrivers/sql_alchemy","title":"Get SQL Alchemy Driver","href":"/api-reference/supported-drivers/get-sql-alchemy-driver"}]},{"group":"Data -- Metadata","pages":[{"openapi":"get /metadata/{projectId}","title":"Get Project Metadata","href":"/api-reference/data--metadata/get-project-metadata"},{"openapi":"put /metadata/{projectId}/categorical/{catalogId}/{schemaName}/{tableName}/{columnName}","title":"Generate categorical values from the column.","href":"/api-reference/data--metadata/generate-categorical-values-from-the-column"},{"openapi":"delete /metadata/{projectId}/categorical/{catalogId}/{schemaName}/{tableName}/{columnName}","title":"Delete categorical values from the column meta and remove the scheduled job","href":"/api-reference/data--metadata/delete-categorical-values-from-the-column-meta-and-remove-the-scheduled-job"},{"openapi":"get /metadata/{projectId}/golden-sql/query","title":"Semantic query golden sqls for the project.","href":"/api-reference/data--metadata/semantic-query-golden-sqls-for-the-project"},{"openapi":"get /metadata/{projectId}/golden-sqls","title":"List of golden sqls for the project.","href":"/api-reference/data--metadata/list-of-golden-sqls-for-the-project"},{"openapi":"post /metadata/{projectId}/golden-sqls","title":"Create golden sql for the project","href":"/api-reference/data--metadata/create-golden-sql-for-the-project"},{"openapi":"delete /metadata/{projectId}/golden-sqls/{id}","title":"Delete golden sql from the project.","href":"/api-reference/data--metadata/delete-golden-sql-from-the-project"},{"openapi":"get /metadata/{projectId}/query","title":"Semantic query metadata for the project.","href":"/api-reference/data--metadata/semantic-query-metadata-for-the-project"},{"openapi":"get /metadata/{projectId}/questions/generate","title":"Generate sample ai questions for the project","href":"/api-reference/data--metadata/generate-sample-ai-questions-for-the-project"},{"openapi":"post /metadata/{projectId}/refresh","title":"Refresh Project Metadata","href":"/api-reference/data--metadata/refresh-project-metadata"},{"openapi":"get /metadata/{projectId}/refresh/callback","title":"Get Metadata Refresh Job Callback","href":"/api-reference/data--metadata/get-metadata-refresh-job-callback"},{"openapi":"post /metadata/{projectId}/refresh/callback","title":"Register Metadata Refresh Job Callback","href":"/api-reference/data--metadata/register-metadata-refresh-job-callback"},{"openapi":"delete /metadata/{projectId}/refresh/callback","title":"Unregister Metadata Refresh Job Callback","href":"/api-reference/data--metadata/unregister-metadata-refresh-job-callback"},{"openapi":"get /metadata/{projectId}/refresh/{catalogId}","title":"Get Metadata Refresh Job Status","href":"/api-reference/data--metadata/get-metadata-refresh-job-status"},{"openapi":"get /metadata/{projectId}/relations/{catalogId}","title":"Get Project Catalog Metadata Relations","href":"/api-reference/data--metadata/get-project-catalog-metadata-relations"},{"openapi":"post /metadata/{projectId}/relations/{catalogId}/{schemaName}/{tableName}/{columnName}","title":"Add Relation To Metadata","href":"/api-reference/data--metadata/add-relation-to-metadata"},{"openapi":"put /metadata/{projectId}/relations/{catalogId}/{schemaName}/{tableName}/{relationId}","title":"Update Relation From Metadata","href":"/api-reference/data--metadata/update-relation-from-metadata"},{"openapi":"delete /metadata/{projectId}/relations/{catalogId}/{schemaName}/{tableName}/{relationId}","title":"Delete Relation From Metadata","href":"/api-reference/data--metadata/delete-relation-from-metadata"},{"openapi":"post /metadata/{projectId}/semantics/{catalogId}/{schemaName}/{tableName}","title":"Generate semantics for the table","href":"/api-reference/data--metadata/generate-semantics-for-the-table"},{"openapi":"put /metadata/{projectId}/{catalogId}","title":"Update Metadata ai usage per catalog level","href":"/api-reference/data--metadata/update-metadata-ai-usage-per-catalog-level"},{"openapi":"put /metadata/{projectId}/{catalogId}/{schemaName}","title":"Update Metadata ai usage per schema level","href":"/api-reference/data--metadata/update-metadata-ai-usage-per-schema-level"},{"openapi":"put /metadata/{projectId}/{catalogId}/{schemaName}/{tableName}","title":"Update Metadata","href":"/api-reference/data--metadata/update-metadata"}]},{"group":"AI -- AgentV2","pages":[{"openapi":"get /ai-agent/workflow/png","title":"Get png image of current ai workflow","href":"/api-reference/ai--agentv2/get-png-image-of-current-ai-workflow"},{"openapi":"post /ai-agent/{projectId}/chat","title":"Chat with agent","href":"/api-reference/ai--agentv2/chat-with-agent"},{"openapi":"post /ai-agent/{projectId}/chat/stream","title":"Chat with agent via stream","href":"/api-reference/ai--agentv2/chat-with-agent-via-stream"},{"openapi":"get /ai-agent/{projectId}/threads","title":"List ai-agent threads","href":"/api-reference/ai--agentv2/list-ai-agent-threads"},{"openapi":"get /ai-agent/{projectId}/threads/{threadId}","title":"Get ai-agent thread","href":"/api-reference/ai--agentv2/get-ai-agent-thread"},{"openapi":"put /ai-agent/{projectId}/threads/{threadId}","title":"Update ai-agent thread display name","href":"/api-reference/ai--agentv2/update-ai-agent-thread-display-name"},{"openapi":"delete /ai-agent/{projectId}/threads/{threadId}","title":"Delete ai-agent thread","href":"/api-reference/ai--agentv2/delete-ai-agent-thread"}]},{"group":"Data -- SQL","pages":[{"openapi":"post /sql/transpile/{dialect}","title":"Transpile SQL","href":"/api-reference/data--sql/transpile-sql"}]},{"group":"Data -- Materialized Queries","pages":[{"openapi":"get /data/projects/{projectId}/materialized-queries/status","title":"List Materialized Query Statuses","href":"/api-reference/data--materialized-queries/list-materialized-query-statuses"},{"openapi":"post /data/projects/{projectId}/materialized-queries/{queryId}/cancel","title":"Cancel Materialized Query Refresh","href":"/api-reference/data--materialized-queries/cancel-materialized-query-refresh"},{"openapi":"post /data/projects/{projectId}/materialized-queries/{queryId}/refresh","title":"Refresh Materialized Query","href":"/api-reference/data--materialized-queries/refresh-materialized-query"},{"openapi":"get /data/projects/{projectId}/materialized-queries/{queryId}/status","title":"Read Materialized Query Status","href":"/api-reference/data--materialized-queries/read-materialized-query-status"}]}]},{"tab":"MCP","href":"https://www.peaka.com/docs/mcp/overview"},{"tab":"Embedded Peaka","href":"https://www.peaka.com/docs/embedded-peaka/introduction"},{"tab":"SQL Reference","href":"https://www.peaka.com/docs/sql/introduction"},{"tab":"Integrations","href":"https://www.peaka.com/docs/integrations/activecampaign"},{"tab":"BI Tools","href":"https://www.peaka.com/docs/bi-tools/looker-studio"},{"tab":"DB Drivers","href":"https://www.peaka.com/docs/db-drivers/python"},{"tab":"JEXL","href":"https://www.peaka.com/docs/jexl/using-jexl"},{"tab":"Flows","href":"https://www.peaka.com/docs/flows/how-to-create-a-flow"},{"tab":"Cookbook","href":"https://www.peaka.com/docs/cookbook/how-to-combine-connector-and-peaka-table-data"}]},"basePath":"","title":"Execute Query - Peaka","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a74be98ba7","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B7XKH4J3.js","utils-lOYzL7z-.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DF6jUUIM.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dpsj5f7C.js","snippetPresets-CYeiDe8v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CUFz1YZ_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D8H_iLS4.js","shallow-DdluZBHX.js","getApiPlaygroundDisplay-B9922vev.js","CodeSnippet-CMoRNGYs.js","CodeSnippets-DwyrPHuw.js","Page-DSVu9Ucl.js","getPastedJson-G-zIvlHh.js","icon-B03fnEy0.js","MethodPill-CW7teklc.js","DuplicateIcon-CtO8eekd.js","createIcon-DZTKdM_A.js","DynamicMarkdown-D5M2At0B.js","SectionHeading-C_2NaA2U.js","axios-vUo_bRtp.js","zoom-image-lightbox-DL4wrF0w.js","lightbox-handle-r17bVUz3.js","Markdown-D7QRHV3m.js","clsx-D1Z-ELXV.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-lvhuD9Du.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CKfC4ywL.js"]}