Create a custom report with your own selection of insight entries. Set organizational to true to share the report with every user in your organization instead of keeping it personal.
Reports created through the API are always custom reports: the report-level builtIn flag is set only by Syntage and cannot be set through the API.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Syntage","colors":{"primary":"#1975FF","light":"#1975FF"},"logo":{"light":"https://mintcdn.com/syntage/NuYQc9gEjSxFZJMz/logo.svg?fit=max\u0026auto=format\u0026n=NuYQc9gEjSxFZJMz\u0026q=85\u0026s=976345a01e03638f59ea0f9cb2a7d8d3","dark":"https://mintcdn.com/syntage/Guui-PNq2RqcZDxJ/logo-dark.svg?fit=max\u0026auto=format\u0026n=Guui-PNq2RqcZDxJ\u0026q=85\u0026s=fb29ea6c7437fb18ca359ce2c22460f9"},"favicon":"https://mintcdn.com/syntage/UtiP7paDbtCUc-2P/favicon.ico?fit=max\u0026auto=format\u0026n=UtiP7paDbtCUc-2P\u0026q=85\u0026s=37b2c70e584adf9b64dedef8bd5fbabb","api":{"mdx":{"auth":{"method":"key","name":"x-api-key"},"server":"https://api.syntage.com"}},"navbar":{"links":[{"href":"https://support.syntage.com","label":"Support"}],"primary":{"type":"button","label":"Go to App","href":"https://app.syntage.com"}},"contextual":{"options":["copy","view","assistant","chatgpt","claude","aistudio","mcp","add-mcp","cursor","vscode","devin-mcp","download-spec"],"display":"header"},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","default":true,"href":""},{"language":"es","href":"es"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"syntage","hasAudioNarration":false,"actualSubdomain":"syntage","customDomains":["docs.syntage.com"],"gitSource":{"type":"github","owner":"syntagecom","repo":"platform.backend","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adfafea548e271193b3d0a7","collectionId":"08bf5cec-169d-4adc-9e5b-7ba68dfa4426","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adfafea548e271193b3d0a7"},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6adfc80090d5a1b4c600fb39","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"en","tag":"API Reference","count":178},{"language":"en","tag":"Datasource: SAT","count":47},{"language":"en","tag":"Core Resources","count":42},{"language":"en","tag":"Resource Guide","count":40},{"language":"es","tag":"Guía de recursos","count":40},{"language":"en","tag":"Insights","count":32},{"language":"en","tag":"Invoices","count":32},{"language":"en","tag":"Datasources","count":28},{"language":"es","tag":"Fuentes de datos","count":28},{"language":"en","tag":"Other Resources","count":23},{"language":"en","tag":"Using Syntage","count":21},{"language":"es","tag":"Usar Syntage","count":21},{"language":"en","tag":"Entities","count":18},{"language":"es","tag":"SAT","count":14},{"language":"es","tag":"Dashboard","count":8},{"language":"es","tag":"Recursos principales","count":6},{"language":"es","tag":"Facturas","count":6},{"language":"es","tag":"Desarrolladores","count":5},{"language":"es","tag":"Comienza aquí","count":5},{"language":"es","tag":"Cómo funciona Syntage","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":"editor-v7-file-tree","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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"editor-agent-model-picker","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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/reports/create-a-report","slug":"/api-reference/reports/create-a-report","pageMetadata":{"openapi":"post /reports","title":"Create a report","description":"Create a custom report with your own selection of insight entries. Set `organizational` to `true` to share the report with every user in your organization instead of keeping it personal.\n\nReports created through the API are always custom reports: the report-level `builtIn` flag is set only by Syntage and cannot be set through the API.\n","href":"/api-reference/reports/create-a-report"},"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 ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Create a custom report with your own selection of insight entries. Set \", _jsx(_components.code, {\n children: \"organizational\"\n }), \" to \", _jsx(_components.code, {\n children: \"true\"\n }), \" to share the report with every user in your organization instead of keeping it personal.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Reports created through the API are always custom reports: the report-level \", _jsx(_components.code, {\n children: \"builtIn\"\n }), \" flag is set only by Syntage and cannot be set through the API.\"]\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":{"openapi":"post /reports","title":"Create a report","description":"Create a custom report with your own selection of insight entries. Set `organizational` to `true` to share the report with every user in your organization instead of keeping it personal.\n\nReports created through the API are always custom reports: the report-level `builtIn` flag is set only by Syntage and cannot be set through the API.\n","href":"/api-reference/reports/create-a-report"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Reports"],"operationId":"CreateReport","summary":"Create a report","description":"Create a custom report with your own selection of insight entries. Set `organizational` to `true` to share the report with every user in your organization instead of keeping it personal.\n\nReports created through the API are always custom reports: the report-level `builtIn` flag is set only by Syntage and cannot be set through the API.\n","requestBody":"b7d410bf-a7cd-42a1-93a2-9ebc85f90350","responses":{"201":"67f70c77-9a3a-4163-a26e-61905878e566","401":"dfb990e2-131d-4402-b2ba-7502550a34c2","422":"0c46a5b4-45a0-42a3-81b1-95a33f441a16"},"method":"post","type":"path","servers":["719ec665-6b0d-4c0b-9000-a2be1320317e","c5b27647-1e40-48b9-9617-cbeed64bce26"],"security":["3d8bd201-a445-4c8f-a0b5-6a33e65787f0"],"path":"/reports","baseUrlOptions":["https://api.syntage.com","https://api.sandbox.syntage.com"],"title":"Create a report","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","insights"],"properties":{"name":{"type":"string","description":"Report name shown in the dashboard's report selector","example":"Credit review","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"insights":{"type":"array","description":"Ordered layout of insight entries and groups rendered by the report","items":{"type":"object","required":["name","type"],"properties":{"name":{"type":"string","description":"Entry identifier within the report layout","example":"sales-revenue","isRequired":true,"uniqueKey":"insights.items.[INDEX].name","typeLabel":"string"},"type":{"type":"string","description":"`insight` renders a single insight; `group` renders a titled section of child insight entries","enum":["insight","group"],"isRequired":true,"uniqueKey":"insights.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"insight":{"type":"string","description":"Name of the insight rendered by this entry; required when `type` is `insight`","example":"sales-revenue","uniqueKey":"insights.items.[INDEX].insight","typeLabel":"string"},"visible":{"type":"boolean","description":"Whether the entry is shown when the report is rendered","uniqueKey":"insights.items.[INDEX].visible","typeLabel":"boolean"},"children":{"type":"array","description":"Child insight entries; used when `type` is `group`","items":{"$circularRef":"88155eb1-543b-45d0-ac6c-d7dcb7bd5be6"},"uniqueKey":"insights.items.[INDEX].children","typeLabel":"array"}},"uniqueKey":"insights.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"insights","typeLabel":"object[]"},"organizational":{"type":"boolean","description":"Share the report with every user in the organization instead of keeping it personal","default":false,"uniqueKey":"organizational","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"Credit review","insights":[{"name":"sales-revenue","insight":"sales-revenue","visible":true,"children":"\u003carray>"}],"organizational":false}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"67f70c77-9a3a-4163-a26e-61905878e566":{"description":"Report resource response","content":{"application/ld+json":{"schema":{"type":"object","properties":{"@context":{"type":"string","default":"/contexts/InsightReport","uniqueKey":"@context","typeLabel":"string"},"@id":{"type":"string","format":"iri-reference","description":"Report IRI reference","example":"/reports/91106968-1abd-4d64-85c1-4e73d96fb997","uniqueKey":"@id","typeLabel":"string\u003ciri-reference>"},"@type":{"type":"string","description":"JSON-LD resource type","default":"InsightReport","uniqueKey":"@type","typeLabel":"string"},"id":{"type":"string","format":"uuid","description":"Unique report ID","example":"91106968-1abd-4d64-85c1-4e73d96fb997","uniqueKey":"id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"Report name shown in the dashboard's report selector; built-in reports use stable names such as `full_report`","example":"Credit review","uniqueKey":"name","typeLabel":"string"},"builtIn":{"type":"boolean","description":"Whether the report is managed by Syntage; built-in reports are kept up to date automatically and cannot be modified or deleted","example":false,"uniqueKey":"builtIn","typeLabel":"boolean"},"organizational":{"type":"boolean","description":"Whether the report is shared with every user in the organization; personal reports are only visible to their owner","example":false,"uniqueKey":"organizational","typeLabel":"boolean"},"insights":{"type":"array","description":"Ordered layout of insight entries and groups rendered by the report","items":{"type":"object","required":["name","type"],"properties":{"name":{"type":"string","description":"Entry identifier within the report layout","example":"sales-revenue","isRequired":true,"uniqueKey":"insights.items.[INDEX].name","typeLabel":"string"},"type":{"type":"string","description":"`insight` renders a single insight; `group` renders a titled section of child insight entries","enum":["insight","group"],"isRequired":true,"uniqueKey":"insights.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"insight":{"type":"string","description":"Name of the insight rendered by this entry; present when `type` is `insight`","example":"sales-revenue","uniqueKey":"insights.items.[INDEX].insight","typeLabel":"string"},"visible":{"type":"boolean","description":"Whether the entry is currently shown when the report is rendered","uniqueKey":"insights.items.[INDEX].visible","typeLabel":"boolean"},"children":{"type":"array","description":"Child insight entries; present when `type` is `group`","items":{"$circularRef":"9f9fb375-b55e-49ce-87e4-327ba8874107"},"uniqueKey":"insights.items.[INDEX].children","typeLabel":"array"},"builtIn":{"type":"boolean","description":"Whether the entry comes from a built-in report definition; omitted for entries defined in custom reports","uniqueKey":"insights.items.[INDEX].builtIn","typeLabel":"boolean"}},"uniqueKey":"insights.items.[INDEX]","typeLabel":"object"},"uniqueKey":"insights","typeLabel":"object[]"},"createdBy":{"type":"object","description":"Profile of the user who created the report; omitted for built-in reports","properties":{"id":{"type":"string","format":"uuid","description":"User ID","example":"91106968-1abd-4d64-85c1-4e73d96fb997","uniqueKey":"createdBy.id","typeLabel":"string\u003cuuid>"},"firstName":{"type":"string","example":"John","uniqueKey":"createdBy.firstName","typeLabel":"string"},"lastName":{"type":"string","example":"Doe","uniqueKey":"createdBy.lastName","typeLabel":"string"},"fullName":{"type":"string","example":"John Doe","uniqueKey":"createdBy.fullName","typeLabel":"string"}},"uniqueKey":"createdBy","typeLabel":"object"},"createdAt":{"type":"string","description":"Date and time the resource was created","example":"2020-01-01T12:15:00.000Z","uniqueKey":"createdAt","typeLabel":"string"},"updatedAt":{"type":"string","description":"Date and time the resource was last updated","example":"2020-01-01T12:15:00.000Z","uniqueKey":"updatedAt","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"@context":"/contexts/InsightReport","@id":"/reports/91106968-1abd-4d64-85c1-4e73d96fb997","@type":"InsightReport","id":"91106968-1abd-4d64-85c1-4e73d96fb997","name":"Credit review","builtIn":false,"organizational":false,"insights":[{"name":"sales-revenue","type":"insight","insight":"sales-revenue","visible":true,"children":"\u003carray>","builtIn":true}],"createdBy":{"id":"91106968-1abd-4d64-85c1-4e73d96fb997","firstName":"John","lastName":"Doe","fullName":"John Doe"},"createdAt":"2020-01-01T12:15:00.000Z","updatedAt":"2020-01-01T12:15:00.000Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"dfb990e2-131d-4402-b2ba-7502550a34c2":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"0c46a5b4-45a0-42a3-81b1-95a33f441a16":{"description":"Unprocessable Entity","content":{"application/ld+json":{"schema":{"type":"object","properties":{"@context":{"type":"string","default":"/contexts/Error","uniqueKey":"@context","typeLabel":"string"},"@type":{"type":"string","default":"hydra:Error","uniqueKey":"@type","typeLabel":"string"},"hydra:title":{"type":"string","default":"An error occurred","uniqueKey":"hydra:title","typeLabel":"string"},"hydra:description":{"type":"string","description":"Concatenated violation messages","example":"exampleField: Syntage score already exists.","uniqueKey":"hydra:description","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"@context":"/contexts/Error","@type":"hydra:Error","hydra:title":"An error occurred","hydra:description":"exampleField: Syntage score already exists."}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"3d8bd201-a445-4c8f-a0b5-6a33e65787f0":{"ApiKey":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Your API key is available in the [Production](https://app.syntage.com/settings/api-keys) and [Sandbox](https://app.sandbox.syntage.com/settings/api-keys) dashboards.\n","scopes":[],"schemeName":"ApiKey"}}},"servers":{"719ec665-6b0d-4c0b-9000-a2be1320317e":{"url":"https://api.syntage.com","description":"Production"},"c5b27647-1e40-48b9-9617-cbeed64bce26":{"url":"https://api.sandbox.syntage.com","description":"Sandbox"}},"schemas":{"88155eb1-543b-45d0-ac6c-d7dcb7bd5be6":{"type":"object","required":["name","type"],"properties":{"name":{"type":"string","description":"Entry identifier within the report layout","example":"sales-revenue","isRequired":true},"type":{"type":"string","description":"`insight` renders a single insight; `group` renders a titled section of child insight entries","enum":["insight","group"],"isRequired":true},"insight":{"type":"string","description":"Name of the insight rendered by this entry; required when `type` is `insight`","example":"sales-revenue"},"visible":{"type":"boolean","description":"Whether the entry is shown when the report is rendered"},"children":{"type":"array","description":"Child insight entries; used when `type` is `group`","items":{"$circularRef":"88155eb1-543b-45d0-ac6c-d7dcb7bd5be6"}}}},"9f9fb375-b55e-49ce-87e4-327ba8874107":{"type":"object","required":["name","type"],"properties":{"name":{"type":"string","description":"Entry identifier within the report layout","example":"sales-revenue","isRequired":true},"type":{"type":"string","description":"`insight` renders a single insight; `group` renders a titled section of child insight entries","enum":["insight","group"],"isRequired":true},"insight":{"type":"string","description":"Name of the insight rendered by this entry; present when `type` is `insight`","example":"sales-revenue"},"visible":{"type":"boolean","description":"Whether the entry is currently shown when the report is rendered"},"children":{"type":"array","description":"Child insight entries; present when `type` is `group`","items":{"$circularRef":"9f9fb375-b55e-49ce-87e4-327ba8874107"}},"builtIn":{"type":"boolean","description":"Whether the entry comes from a built-in report definition; omitted for entries defined in custom reports"}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Your API key is available in the [Production](https://app.syntage.com/settings/api-keys) and [Sandbox](https://app.sandbox.syntage.com/settings/api-keys) dashboards.\n","scopes":[],"schemeName":"ApiKey"},"schema":{"title":"X-API-Key","type":"string","description":"Your API key is available in the [Production](https://app.syntage.com/settings/api-keys) and [Sandbox](https://app.sandbox.syntage.com/settings/api-keys) dashboards.\n","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKey","name":"X-API-Key"}],"title":"ApiKey"}]},"originalFileLocation":"openapi/openapi.yaml"},"subdomain":"syntage","siteName":"Syntage","title":"Create a report - Syntage","navMaps":{"firstHrefInVersion":{"2020-06-28":{"href":"/api-reference/reports/create-a-report","matchLevel":0}},"firstHrefInLanguage":{"en":{"href":"/api-reference/reports/create-a-report","matchLevel":0},"es":{"href":"/es","matchLevel":4}}},"lastModified":"2026-07-17T16:26:05.688Z","originalFileLocation":"api-reference/reports/create-a-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=\"Create a custom report with your own selection of insight entries. Set organizational to true to share the report with every user in your organization instead of keeping it personal. Reports created through the API are always custom reports: the report-level builtIn flag is set only by Syntage and cannot be set through the API.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Syntage\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/syntage/4Xa1qFNlW0Ql_9Ak/_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/syntage/4Xa1qFNlW0Ql_9Ak/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/syntage/4Xa1qFNlW0Ql_9Ak/_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/syntage/4Xa1qFNlW0Ql_9Ak/_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/syntage/4Xa1qFNlW0Ql_9Ak/_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/syntage/4Xa1qFNlW0Ql_9Ak/_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/syntage/4Xa1qFNlW0Ql_9Ak/_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/syntage/4Xa1qFNlW0Ql_9Ak/_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/syntage/4Xa1qFNlW0Ql_9Ak/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a report - Syntage\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a custom report with your own selection of insight entries. Set organizational to true to share the report with every user in your organization instead of keeping it personal. Reports created through the API are always custom reports: the report-level builtIn flag is set only by Syntage and cannot be set through the API.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Syntage\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.syntage.com/api-reference/reports/create-a-report\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://syntage.mintlify.app/_mintlify/api/og/v2?division=Reports\u0026amp;title=Create+a+report\u0026amp;description=Create+a+custom+report+with+your+own+selection+of+insight+entries.+Set+%60organizational%60+to+%60true%60+to+share+the+report+with+every+user+in+your+organization+inste\u0026amp;theme=71db65a3f59ffd9e5f96cd77\u0026amp;signature=e521b6803e29b4df44ef1f2a47f671b68196a42233352d6af858f750fa1e982e\">\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=\"Create a report - Syntage\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a custom report with your own selection of insight entries. Set organizational to true to share the report with every user in your organization instead of keeping it personal. Reports created through the API are always custom reports: the report-level builtIn flag is set only by Syntage and cannot be set through the API.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://syntage.mintlify.app/_mintlify/api/og/v2?division=Reports\u0026amp;title=Create+a+report\u0026amp;description=Create+a+custom+report+with+your+own+selection+of+insight+entries.+Set+%60organizational%60+to+%60true%60+to+share+the+report+with+every+user+in+your+organization+inste\u0026amp;theme=71db65a3f59ffd9e5f96cd77\u0026amp;signature=e521b6803e29b4df44ef1f2a47f671b68196a42233352d6af858f750fa1e982e\">\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/syntage/4Xa1qFNlW0Ql_9Ak/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Syntage\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1975FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.syntage.com/api-reference/reports/create-a-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/create-a-report.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.syntage.com/#organization\",\"name\":\"Syntage\",\"url\":\"https://docs.syntage.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/syntage/NuYQc9gEjSxFZJMz/logo.svg?fit=max\u0026auto=format\u0026n=NuYQc9gEjSxFZJMz\u0026q=85\u0026s=976345a01e03638f59ea0f9cb2a7d8d3\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.syntage.com#website\",\"name\":\"Syntage\",\"url\":\"https://docs.syntage.com\",\"publisher\":{\"@id\":\"https://docs.syntage.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.syntage.com/api-reference/reports/create-a-report#webpage\",\"url\":\"https://docs.syntage.com/api-reference/reports/create-a-report\",\"name\":\"Create a report\",\"description\":\"Create a custom report with your own selection of insight entries. Set organizational to true to share the report with every user in your organization instead of keeping it personal. Reports created through the API are always custom reports: the report-level builtIn flag is set only by Syntage and cannot be set through the API.\",\"dateModified\":\"2026-07-17T16:26:05.688Z\",\"isPartOf\":{\"@id\":\"https://docs.syntage.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.syntage.com/api-reference/reports/create-a-report#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.syntage.com/api-reference/reports/create-a-report#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Reports\",\"item\":\"https://docs.syntage.com/api-reference/reports/list-reports\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a report\",\"item\":\"https://docs.syntage.com/api-reference/reports/create-a-report\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.syntage.com/api-reference/reports/create-a-report#apireference\",\"headline\":\"Create a report\",\"name\":\"Create a report\",\"description\":\"Create a custom report with your own selection of insight entries. Set organizational to true to share the report with every user in your organization instead of keeping it personal. Reports created through the API are always custom reports: the report-level builtIn flag is set only by Syntage and cannot be set through the API.\",\"url\":\"https://docs.syntage.com/api-reference/reports/create-a-report\",\"mainEntityOfPage\":{\"@id\":\"https://docs.syntage.com/api-reference/reports/create-a-report#webpage\"},\"dateModified\":\"2026-07-17T16:26:05.688Z\",\"publisher\":{\"@id\":\"https://docs.syntage.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.syntage.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Syntage\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Syntage","nav":{"global":null,"languages":[{"language":"en","default":true,"tabs":[{"tab":"Using Syntage","pages":[{"title":"Using Syntage","href":""}]},{"tab":"Resource Guide","pages":[{"title":"Resource Guide","href":"/resources/core/entities"}]},{"tab":"Developers","pages":[{"title":"Developers","href":"/developers/overview"}]},{"tab":"API Reference","versions":[{"version":"2020-06-28","default":true,"pages":[{"title":"API Reference","href":"/api-reference/introduction"},{"group":"Core Resources","pages":[{"group":"Events","pages":[{"openapi":"get /events","title":"List all events","href":"/api-reference/events/list-all-events"},{"openapi":"get /events/{id}","title":"Retrieve an event","href":"/api-reference/events/retrieve-an-event"}]},{"group":"Files","pages":[{"openapi":"get /files/{id}","title":"Retrieve a file","href":"/api-reference/files/retrieve-a-file"},{"openapi":"get /files/{id}/download","title":"Download content","href":"/api-reference/files/download-the-file-content"}]},{"group":"Exports","pages":[{"openapi":"post /exports","title":"Export data","href":"/api-reference/exports/export-data"},{"openapi":"get /exports","title":"List all exports","href":"/api-reference/exports/list-all-exports"},{"openapi":"get /exports/{id}","title":"Retrieve an export","href":"/api-reference/exports/retrieve-an-export"}]},{"group":"Entities","pages":[{"openapi":"get /entities","title":"List all entities","href":"/api-reference/entities/list-all-entities"},{"openapi":"post /entities","title":"Add an Entity","href":"/api-reference/entities/add-an-entity"},{"openapi":"get /entities/{entityId}","title":"Retrieve an Entity","href":"/api-reference/entities/retrieve-an-entity"},{"openapi":"patch /entities/{entityId}","title":"Update an Entity","href":"/api-reference/entities/update-an-entity"},{"openapi":"delete /entities/{entityId}","title":"Delete an Entity","href":"/api-reference/entities/delete-an-entity"},{"group":"Favorites","pages":[{"title":"Favorite one or more entities","openapi":"post /entities/favorites","href":"/api-reference/entities/favorite-multiple-entities"},{"title":"Unfavorite one or more entities","openapi":"delete /entities/favorites","href":"/api-reference/entities/unfavorite-multiple-entities"}]},{"group":"Events","pages":[{"openapi":"get /entities/{entityId}/events","title":"List an entity's events","href":"/api-reference/entities/list-an-entitys-events"}]},{"group":"Identifiers","pages":[{"openapi":"get /entities/{entityId}/identifiers","title":"List an entity's identifiers","href":"/api-reference/entities/list-an-entitys-identifiers"},{"openapi":"post /entities/{entityId}/identifiers","title":"Add an entity identifier","href":"/api-reference/entities/add-an-entity-identifier"}]},{"group":"Entity Tags","pages":[{"openapi":"get /entities/{entityId}/tags","title":"List an entity's tags","href":"/api-reference/entities/list-an-entitys-tags"},{"openapi":"get /entity-tags","title":"List all entity tags","href":"/api-reference/entities/list-all-entity-tags"},{"openapi":"post /entity-tags","title":"Create an entity tag","href":"/api-reference/entities/create-an-entity-tag"},{"openapi":"get /entity-tags/{id}","title":"Retrieve an entity tag","href":"/api-reference/entities/retrieve-an-entity-tag"},{"openapi":"patch /entity-tags/{id}","title":"Update an entity tag","href":"/api-reference/entities/update-an-entity-tag"},{"openapi":"delete /entity-tags/{id}","title":"Delete an entity tag","href":"/api-reference/entities/delete-an-entity-tag"},{"openapi":"post /entities/batch/tags","title":"Tag multiple entities","href":"/api-reference/entities/tag-multiple-entities"},{"openapi":"post /entities/batch/tags/remove","title":"Untag multiple entities","href":"/api-reference/entities/untag-multiple-entities"}]}]},{"group":"Tags","pages":[{"openapi":"get /tags","title":"List all tags","href":"/api-reference/tags/list-all-tags"},{"openapi":"post /tags","title":"Create a tag","href":"/api-reference/tags/create-a-tag"},{"openapi":"delete /tags/{id}","title":"Delete a tag","href":"/api-reference/tags/delete-a-tag"},{"openapi":"patch /tags/{id}","title":"Update a tag","href":"/api-reference/tags/update-a-tag"}]},{"group":"Extractions","pages":[{"openapi":"get /extractions","title":"List all extractions","href":"/api-reference/extractions/list-all-extractions"},{"openapi":"post /extractions","title":"Create an extraction","href":"/api-reference/extractions/create-an-extraction"},{"openapi":"get /extractions/{id}","title":"Retrieve an extraction","href":"/api-reference/extractions/retrieve-an-extraction"},{"openapi":"delete /extractions/{id}/stop","title":"Request the extraction to be stopped","href":"/api-reference/extractions/request-the-extraction-to-be-stopped"},{"group":"Schedulers","pages":[{"openapi":"get /schedulers","title":"List schedulers","href":"/api-reference/schedulers/list-schedulers"},{"openapi":"post /schedulers","title":"Create a scheduler","href":"/api-reference/schedulers/create-an-scheduler"},{"openapi":"get /schedulers/{id}","title":"Retrieve a scheduler","href":"/api-reference/schedulers/retrieve-an-scheduler"},{"openapi":"put /schedulers/{id}","title":"Update a scheduler","href":"/api-reference/schedulers/update-an-scheduler"},{"openapi":"delete /schedulers/{id}","title":"Delete a scheduler","href":"/api-reference/schedulers/delete-an-scheduler"},{"group":"Rules","pages":[{"openapi":"post /schedulers/rules","title":"Create a scheduler rule","href":"/api-reference/scheduler-rules/create-an-scheduler-rule"},{"openapi":"get /schedulers/rules/{id}","title":"Retrieve a scheduler rule","href":"/api-reference/scheduler-rules/retrieve-an-scheduler-rule"},{"openapi":"put /schedulers/rules/{id}","title":"Update a scheduler rule","href":"/api-reference/scheduler-rules/update-an-scheduler-rule"},{"openapi":"delete /schedulers/rules/{id}","title":"Delete a scheduler rule","href":"/api-reference/scheduler-rules/delete-an-scheduler-rule"}]}]}]}]},{"group":"Other Resources","pages":[{"group":"Shareholders","pages":[{"openapi":"get /entities/{entityId}/shareholders","title":"List an entity's shareholders","href":"/api-reference/shareholders/get-an-entitys-shareholders"},{"openapi":"post /entities/{entityId}/shareholders","title":"Create a new shareholder for an entity","href":"/api-reference/shareholders/create-a-new-shareholder-for-an-entity"},{"openapi":"get /shareholders","title":"List shareholders","href":"/api-reference/shareholders/get-all-shareholders"},{"openapi":"get /shareholders/{id}","title":"Retrieve a shareholder","href":"/api-reference/shareholders/get-a-specific-shareholder"},{"openapi":"patch /shareholders/{id}","title":"Update a shareholder","href":"/api-reference/shareholders/update-a-shareholder"},{"openapi":"delete /shareholders/{id}","title":"Delete a shareholder","href":"/api-reference/shareholders/delete-a-shareholder"},{"group":"Relations","pages":[{"openapi":"get /shareholders/{shareholderId}/relations","title":"List shareholder relations","href":"/api-reference/shareholders/get-shareholder-relations"},{"openapi":"get /shareholders/{shareholderId}/relations/{relationId}","title":"Retrieve a shareholder relation","href":"/api-reference/shareholders/get-a-specific-shareholder-relation"},{"openapi":"patch /shareholders/{shareholderId}/relations/{relationId}","title":"Update a shareholder relation","href":"/api-reference/shareholders/update-a-shareholder-relation"},{"openapi":"delete /shareholders/{shareholderId}/relations/{relationId}","title":"Delete a shareholder relation","href":"/api-reference/shareholders/delete-a-shareholder-relation"},{"openapi":"post /shareholders/{shareholderId}/relations/{relationId}/promote","title":"Promote a shareholder relation","href":"/api-reference/shareholders/promote-a-shareholder-relation"}]},{"group":"Sources","pages":[{"openapi":"get /shareholders/{shareholderId}/relations/{relationId}/sources","title":"List shareholder relation sources","href":"/api-reference/shareholders/get-shareholder-relation-sources"},{"openapi":"get /shareholders/{shareholderId}/relations/{relationId}/sources/{sourceId}","title":"Retrieve a shareholder relation source","href":"/api-reference/shareholders/get-a-specific-shareholder-relation-source"},{"openapi":"delete /shareholders/{shareholderId}/relations/{relationId}/sources/{sourceId}","title":"Delete a shareholder relation source","href":"/api-reference/shareholders/delete-a-shareholder-relation-source"}]}]},{"group":"Background Checks","pages":[{"openapi":"get /background-checks","title":"List background checks","href":"/api-reference/background-checks/get-all-background-checks"},{"openapi":"get /background-checks/{id}","title":"Retrieve a background check","href":"/api-reference/background-checks/get-a-specific-background-check"},{"openapi":"get /background-checks/{id}/pdf","title":"Download background check PDF","href":"/api-reference/background-checks/get-background-check-pdf-report"},{"openapi":"get /entities/{entityId}/background-checks","title":"List an entity's background checks","href":"/api-reference/background-checks/get-an-entitys-background-checks"},{"openapi":"get /background-checks/{backgroundCheckId}/records","title":"List background check records","href":"/api-reference/background-checks/get-background-check-records"}]},{"group":"Company Verification Reports","pages":[{"openapi":"get /datasources/mx/company-verification/reports","title":"List company verification reports","href":"/api-reference/company-verification-reports/get-all-company-verification-reports"},{"openapi":"get /datasources/mx/company-verification/reports/{id}","title":"Retrieve a company verification report","href":"/api-reference/company-verification-reports/get-a-specific-company-verification-report"},{"openapi":"get /entities/{entityId}/datasources/mx/company-verification/reports","title":"List an entity's company verification reports","href":"/api-reference/company-verification-reports/get-an-entitys-company-verification-reports"}]},{"group":"Mexico Addresses","pages":[{"title":"Retrieve addresses by postal code","openapi":"get /datasources/mx/addresses/{postalCode}","href":"/api-reference/mexico-addresses/retrieve-addresses-by-postal-code"}]}]},{"group":"Datasource: SAT","pages":[{"group":"Credentials","pages":[{"openapi":"get /credentials","title":"List all credentials","href":"/api-reference/ds-mx-sat-credentials/list-all-credentials"},{"openapi":"post /credentials","title":"Create a credential","href":"/api-reference/ds-mx-sat-credentials/create-a-credential"},{"openapi":"get /credentials/{id}","title":"Retrieve a credential","href":"/api-reference/ds-mx-sat-credentials/retrieve-a-credential"},{"openapi":"delete /credentials/{id}","title":"Delete a credential","href":"/api-reference/ds-mx-sat-credentials/delete-a-credential"},{"openapi":"post /credentials/{id}/revalidate","title":"Revalidate a credential","href":"/api-reference/ds-mx-sat-credentials/revalidate-a-credential"}]},{"group":"Invoices","pages":[{"openapi":"get /invoices/{id}","title":"Retrieve an invoice","href":"/api-reference/ds-mx-sat-invoices/retrieve-an-invoice"},{"openapi":"post /invoices/{id}/tags","title":"Tag an invoice","href":"/api-reference/ds-mx-sat-invoices/tag-an-invoice"},{"openapi":"delete /invoices/{invoiceId}/tags/{tagId}","title":"Untag an invoice","href":"/api-reference/ds-mx-sat-invoices/untag-an-invoice"},{"openapi":"post /invoices/batch/tags","title":"Tag multiple invoices","href":"/api-reference/ds-mx-sat-invoices/tag-multiple-invoices"},{"openapi":"post /invoices/batch/tags/remove","title":"Untag multiple invoices","href":"/api-reference/ds-mx-sat-invoices/untag-multiple-invoices"},{"openapi":"get /invoices/{id}/cfdi","title":"Retrieve an invoice's CFDI","href":"/api-reference/ds-mx-sat-invoices/retrieve-an-invoices-cfdi"},{"openapi":"get /datasources/mx/sat/cfdis/{uuid}","title":"Retrieve a SAT CFDI","href":"/api-reference/ds-mx-sat-invoices/retrieve-a-sat-cfdi"},{"openapi":"get /entities/{entityId}/invoices","title":"List an entity's invoices","href":"/api-reference/ds-mx-sat-invoices/list-all-entities-invoices"},{"group":"Line Items","pages":[{"openapi":"get /invoices/line-items/{id}","title":"Retrieve an invoice line item","href":"/api-reference/ds-mx-sat-invoice-line-items/retrieve-an-invoice-line-item"},{"openapi":"get /invoices/{invoiceId}/line-items","title":"List an invoice's line items","href":"/api-reference/ds-mx-sat-invoice-line-items/list-an-invoices-line-items"},{"openapi":"get /entities/{entityId}/invoices/line-items","title":"List an entity's invoice line items","href":"/api-reference/ds-mx-sat-invoice-line-items/list-all-entity-line-items"}]},{"group":"Relations","pages":[{"openapi":"get /invoices/relations/{id}","title":"Retrieve an invoice relation","href":"/api-reference/ds-mx-sat-invoice-relations/retrieve-an-invoice-relation"},{"openapi":"get /invoices/{invoiceId}/relations","title":"List an invoice's relations","href":"/api-reference/ds-mx-sat-invoice-relations/list-an-invoices-relations"},{"openapi":"get /entities/{entityId}/invoices/{invoiceId}/relations","title":"List an entity's invoice relations","href":"/api-reference/ds-mx-sat-invoice-relations/list-an-entitys-invoice-relations"}]},{"group":"Payments","pages":[{"openapi":"get /invoices/payments","title":"List all invoice payments","href":"/api-reference/ds-mx-sat-invoice-payments/list-all-invoice-payments"},{"openapi":"get /invoices/payments/{id}","title":"Retrieve an invoice payment","href":"/api-reference/ds-mx-sat-invoice-payments/retrieve-an-invoice-payment"},{"openapi":"get /invoices/{id}/payments","title":"List an invoice's payments","href":"/api-reference/ds-mx-sat-invoice-payments/list-an-invoices-payments"},{"openapi":"get /entities/{entityId}/invoices/payments","title":"List an entity's invoice payments","href":"/api-reference/ds-mx-sat-invoice-payments/list-entities-invoice-payments"},{"group":"Batch Payments","pages":[{"openapi":"get /invoices/batch-payments","title":"List all invoice batch payments","href":"/api-reference/ds-mx-sat-invoice-batch-payments/list-all-invoice-batch-payments"},{"openapi":"get /invoices/batch-payments/{id}","title":"Retrieve an invoice batch payment","href":"/api-reference/ds-mx-sat-invoice-batch-payments/retrieve-an-invoice-batch-payment"},{"openapi":"get /invoices/{id}/batch-payments","title":"List an invoice's batch payments","href":"/api-reference/ds-mx-sat-invoice-batch-payments/list-an-invoices-batch-payments"}]}]},{"group":"Credit Notes","pages":[{"openapi":"get /invoices/credit-notes","title":"List credit notes","href":"/api-reference/ds-mx-sat-credit-notes/list-credit-notes"},{"openapi":"get /entities/{entityId}/invoices/credit-notes","title":"List an entity's credit notes","href":"/api-reference/ds-mx-sat-credit-notes/list-an-entitys-credit-notes"},{"openapi":"get /invoices/credit-notes/{id}","title":"Retrieve an invoice credit note","href":"/api-reference/ds-mx-sat-credit-notes/retrieve-an-invoice-credit-note"},{"openapi":"get /invoices/{invoiceId}/issued-credit-notes","title":"List an invoice's issued credit notes","href":"/api-reference/ds-mx-sat-credit-notes/list-all-issued-credit-notes-related-to-the-requested-invoice"},{"openapi":"get /invoices/{invoiceId}/applied-credit-notes","title":"List an invoice's applied credit notes","href":"/api-reference/ds-mx-sat-credit-notes/list-all-applied-credit-notes-related-to-the-requested-invoice"}]}]},{"group":"Tax Retentions","pages":[{"openapi":"get /tax-retentions/{id}","title":"Retrieve a tax retention","href":"/api-reference/ds-mx-sat-tax-retentions/retrieve-a-tax-retention"},{"openapi":"get /tax-retentions/{id}/cfdi","title":"Retrieve a tax retention CFDI","href":"/api-reference/ds-mx-sat-tax-retentions/retrieve-a-tax-retention-cfdi"},{"openapi":"get /entities/{entityId}/tax-retentions","title":"List an entity's tax retentions","href":"/api-reference/ds-mx-sat-tax-retentions/list-all-entities-tax-retentions"}]},{"group":"Tax Returns","pages":[{"openapi":"get /tax-returns/{id}","title":"Retrieve a tax return","href":"/api-reference/ds-mx-sat-tax-returns/retrieve-a-tax-return"},{"openapi":"get /tax-returns/{id}/pdf","title":"Download a tax return PDF","href":"/api-reference/ds-mx-sat-tax-returns/download-a-tax-return-pdf"},{"openapi":"get /tax-returns/{id}/data","title":"Retrieve tax return data","href":"/api-reference/ds-mx-sat-tax-returns/retrieve-a-tax-return-data"},{"openapi":"get /entities/{entityId}/tax-returns","title":"List an entity's tax returns","href":"/api-reference/ds-mx-sat-tax-returns/list-all-entities-tax-returns"}]},{"group":"Tax Compliance Checks","pages":[{"openapi":"get /tax-compliance-checks/{id}","title":"Retrieve a tax compliance check","href":"/api-reference/ds-mx-sat-tax-compliance-checks/retrieve-a-tax-compliance-check"},{"openapi":"get /entities/{entityId}/tax-compliance-checks","title":"List an entity's tax compliance checks","href":"/api-reference/ds-mx-sat-tax-compliance-checks/list-all-entities-tax-compliance-checks"}]},{"group":"Tax Status","pages":[{"openapi":"get /tax-status","title":"List tax status records","href":"/api-reference/ds-mx-sat-tax-status/list-tax-status-records"},{"openapi":"get /tax-status/{id}","title":"Retrieve a tax status","href":"/api-reference/ds-mx-sat-tax-status/retrieve-a-tax-status"},{"openapi":"get /entities/{entityId}/tax-status","title":"List an entity's tax status records","href":"/api-reference/ds-mx-sat-tax-status/list-all-entities-tax-status"}]},{"group":"Electronic Accounting","pages":[{"openapi":"get /electronic-accounting-records/{id}","title":"Retrieve an electronic accounting record","href":"/api-reference/ds-mx-sat-electronic-accounting/retrieve-an-electronic-accounting-record"},{"openapi":"get /entities/{entityId}/electronic-accounting-records","title":"List an entity's electronic accounting records","href":"/api-reference/ds-mx-sat-electronic-accounting/list-all-entities-electronic-accounting-records"}]},{"group":"Certificates","pages":[{"openapi":"get /datasources/mx/sat/certificados/{id}","title":"Retrieve a SAT certificate","href":"/api-reference/ds-mx-sat-certificates/retrieve-a-sat-certificate"},{"openapi":"get /entities/{entityId}/datasources/mx/sat/certificados","title":"List an entity's SAT certificates","href":"/api-reference/ds-mx-sat-certificates/list-an-entitys-sat-certificates"}]}]},{"group":"Datasource: RPC","pages":[{"group":"Entidades","pages":[{"openapi":"get /datasources/mx/rpc/entidades/{id}","title":"Retrieve RPC entidade","href":"/api-reference/ds-mx-rpc-entidades/retrieve-rpc-entidades-data-beta"},{"openapi":"get /entities/{entityId}/datasources/mx/rpc/entidades","title":"List an entity's RPC entidades","href":"/api-reference/ds-mx-rpc-entidades/list-all-entities-rpc-entidades-data-beta"}]},{"group":"Actos","pages":[{"openapi":"get /rpc/actos/{id}","title":"Retrieve RPC acto","href":"/api-reference/ds-mx-rpc-actos/retrieve-an-rpc-acto"},{"openapi":"get /entities/{entityId}/datasources/mx/rpc/actos","title":"List an entity's RPC actos","href":"/api-reference/ds-mx-rpc-actos/list-an-entitys-rpc-actos"}]},{"group":"Socios","pages":[{"openapi":"get /datasources/rpc/socios/{id}","title":"Retrieve RPC socio","href":"/api-reference/ds-mx-rpc-socios/retrieve-an-rpc-socio"}]}]},{"group":"Datasource: RUG","pages":[{"group":"Operaciones","pages":[{"openapi":"get /datasources/rug/operaciones/{id}","title":"Retrieve RUG operation","href":"/api-reference/ds-mx-rug-operaciones/retrieve-rug-operacion-data"},{"openapi":"get /entities/{entityId}/datasources/rug/operaciones","title":"List an entity's RUG operations","href":"/api-reference/ds-mx-rug-operaciones/list-all-entities-rug-operaciones-data"}]},{"group":"Garantias","pages":[{"openapi":"get /datasources/rug/garantias/{id}","title":"Retrieve RUG guarantee","href":"/api-reference/ds-mx-rug-garantias/retrieve-rug-garantia-data"},{"openapi":"get /entities/{entityId}/datasources/rug/garantias","title":"List an entity's RUG guarantees","href":"/api-reference/ds-mx-rug-garantias/list-all-entities-rug-garantias-data-beta"}]}]},{"group":"Datasource: Syntage","pages":[{"group":"Score","pages":[{"openapi":"post /entities/{entityId}/datasources/syntage/score/calculate","title":"Start Syntage Score calculation","href":"/api-reference/ds-syntage-score/calculate-syntage-score"}]}]},{"group":"Datasource: Buró de Crédito","pages":[{"group":"Reports","pages":[{"openapi":"get /entities/{entityId}/datasources/mx/buro-de-credito/reports","title":"Get an entity's Buró de Crédito reports","href":"/api-reference/ds-mx-buro-de-credito-reports/get-an-entitys-buro-de-credito-reports"},{"openapi":"get /datasources/mx/buro-de-credito/reports/{id}","title":"Get a Buró de Crédito report","href":"/api-reference/ds-mx-buro-de-credito-reports/get-a-buro-de-credito-report"}]},{"group":"Authorizations","pages":[{"openapi":"get /datasources/mx/buro-de-credito/authorizations","title":"Get Buró de Crédito authorizations","href":"/api-reference/ds-mx-buro-de-credito-authorizations/get-all-buro-de-credito-authorizations"},{"openapi":"get /entities/{entityId}/datasources/mx/buro-de-credito/authorizations","title":"Get an entity's Buró de Crédito authorizations","href":"/api-reference/ds-mx-buro-de-credito-authorizations/get-an-entitys-buro-de-credito-authorizations"},{"openapi":"post /entities/{entityId}/datasources/mx/buro-de-credito/authorizations","title":"Create a Buró de Crédito authorization","href":"/api-reference/ds-mx-buro-de-credito-authorizations/create-a-buro-de-credito-authorization"},{"openapi":"get /datasources/mx/buro-de-credito/authorizations/{id}","title":"Get a Buró de Crédito authorization","href":"/api-reference/ds-mx-buro-de-credito-authorizations/get-a-buro-de-credito-authorization"},{"openapi":"delete /datasources/mx/buro-de-credito/authorizations/{id}","title":"Delete a Buró de Crédito authorization","href":"/api-reference/ds-mx-buro-de-credito-authorizations/delete-a-buro-de-credito-authorization"}]}]},{"group":"Datasource: BIL","pages":[{"group":"Reports","pages":[{"openapi":"get /entities/{entityId}/datasources/bil/reports","title":"List an entity's BIL reports","href":"/api-reference/ds-mx-bil-reports/list-an-entitys-bil-reports"},{"openapi":"get /datasources/bil/reports/{id}","title":"Retrieve a BIL report","href":"/api-reference/ds-mx-bil-reports/retrieve-a-bil-report"}]}]},{"group":"Datasource: Infonavit","pages":[{"group":"Overdue Credits","pages":[{"openapi":"get /entities/{entityId}/datasources/infonavit/overdue-credits","title":"List an entity's Infonavit overdue credits","href":"/api-reference/ds-mx-infonavit-overdue-credits/list-an-entitys-infonavit-overdue-credits"},{"openapi":"get /datasources/infonavit/overdue-credits/{id}","title":"Retrieve an Infonavit overdue credit","href":"/api-reference/ds-mx-infonavit-overdue-credits/retrieve-an-infonavit-overdue-credit"}]}]},{"group":"Insights","pages":[{"group":"Company","pages":[{"title":"Summary Insight","openapi":"get /entities/{entityId}/insights/summary","href":"/api-reference/summary-insight/get-summary"},{"title":"Scores Insight","openapi":"get /entities/{entityId}/insights/metrics/scores","href":"/api-reference/scores-insight/get-scores"},{"title":"Syntage Score Distribution","openapi":"get /insights/metrics/scores/syntage/distribution","href":"/api-reference/scores-insight/get-syntage-score-distribution"},{"title":"Buró de Crédito Summary Insight","openapi":"get /entities/{entityId}/insights/metrics/buro-de-credito/summary","href":"/api-reference/buro-de-credito-summary-insight/get-buro-de-credito-summary"},{"title":"Buró de Crédito Summary Export","openapi":"get /entities/{entityId}/insights/metrics/buro-de-credito/summary/export","href":"/api-reference/buro-de-credito-summary-insight/export-buro-de-credito-summary"},{"title":"Risks Insight","openapi":"get /entities/{entityId}/insights/risks","href":"/api-reference/risks-insight/get-risk-calculations"},{"title":"RPC Shareholders Insight","openapi":"get /entities/{entityId}/insights/rpc-shareholders","deprecated":true,"href":"/api-reference/rpc-shareholders-insight/get-rpc-shareholders-beta"}]},{"group":"Corporate Structure","pages":[{"title":"Shareholders Insight","openapi":"get /entities/{entityId}/insights/shareholders","href":"/api-reference/shareholders-insight/get-shareholders"},{"title":"Current Powers Insight","openapi":"get /entities/{entityId}/insights/corporate-structure/current-powers","href":"/api-reference/corporate-structure-current-powers-insight/get-current-powers"}]},{"group":"Revenue","pages":[{"title":"Invoicing Annual Comparison Insight","openapi":"get /entities/{entityId}/insights/metrics/invoicing-annual-comparison","href":"/api-reference/invoicing-annual-comparison-insight/get-invoicing-annual-comparison-insight"},{"title":"Sales Revenue Insight","openapi":"get /entities/{entityId}/insights/sales-revenue","href":"/api-reference/sales-revenue-insight/get-sales-revenue"},{"title":"Expenditures Insight","openapi":"get /entities/{entityId}/insights/expenditures","href":"/api-reference/expenditures-insight/get-expenditures"},{"title":"Cash Flow Insight","openapi":"get /entities/{entityId}/insights/cash-flow-stats","href":"/api-reference/cash-flow-insight/get-cash-flow"},{"title":"Moratory Interest Insight","openapi":"get /entities/{entityId}/insights/moratory-interest","href":"/api-reference/moratory-interest-insight/get-moratory-interest"},{"title":"Accounts Payable Insight","openapi":"get /entities/{entityId}/insights/accounts-payable","href":"/api-reference/accounts-payable-insight/get-accounts-payable"},{"title":"Accounts Receivable Insight","openapi":"get /entities/{entityId}/insights/accounts-receivable","href":"/api-reference/accounts-receivable-insight/get-accounts-receivable"},{"title":"Invoicing Blacklist Insight","openapi":"get /entities/{entityId}/insights/invoicing-blacklist","href":"/api-reference/invoicing-blacklist-insight/get-invoicing-blacklist"}]},{"group":"Financial","pages":[{"title":"Balance Sheet Insight","openapi":"get /entities/{entityId}/insights/metrics/balance-sheet","href":"/api-reference/balance-sheet-insight/get-balance-sheet-metric"},{"title":"Income Statement Insight","openapi":"get /entities/{entityId}/insights/metrics/income-statement","href":"/api-reference/income-statement-insight/get-metrics-income-statement"},{"title":"Financial Ratios Insight","openapi":"get /entities/{entityId}/insights/financial-ratios","href":"/api-reference/financial-ratios-insight/get-financial-ratios"},{"title":"Trial Balance Insight","openapi":"get /entities/{entityId}/insights/trial-balance","href":"/api-reference/trial-balance-insight/get-trial-balance"}]},{"group":"Clients","pages":[{"title":"Customer Concentration Insight","openapi":"get /entities/{entityId}/insights/customer-concentration","href":"/api-reference/customer-concentration-insight/get-customer-invoice-concentration"},{"title":"Customer Network Insight","openapi":"get /entities/{entityId}/insights/metrics/customer-network","href":"/api-reference/customer-network-insight/get-customer-network-insight"},{"title":"Products and Services Sold Insight","openapi":"get /entities/{entityId}/insights/products-and-services-sold","href":"/api-reference/products-and-services-sold-insight/get-products-and-services-sold"},{"title":"Government Customers Insight","openapi":"get /entities/{entityId}/insights/government-customers","href":"/api-reference/government-customers-insight/get-government-customers"}]},{"group":"Providers","pages":[{"title":"Vendor Concentration Insight","openapi":"get /entities/{entityId}/insights/supplier-concentration","href":"/api-reference/vendor-concentration-insight/get-vendor-invoice-concentration"},{"title":"Vendor Network Insight","openapi":"get /entities/{entityId}/insights/metrics/vendor-network","href":"/api-reference/vendor-network-insight/get-vendor-network-insight"},{"title":"Products and Services Bought Insight","openapi":"get /entities/{entityId}/insights/products-and-services-bought","href":"/api-reference/products-and-services-bought-insight/get-products-and-services-bought"},{"title":"Financial Institutions Insight","openapi":"get /entities/{entityId}/insights/financial-institutions","href":"/api-reference/financial-institutions-insight/get-financial-institutions"},{"title":"Employees Insight","openapi":"get /entities/{entityId}/insights/employees","href":"/api-reference/employees-insight/get-employees"}]},{"title":"Invoicing Concentration Insight","openapi":"get /entities/{entityId}/insights/invoicing-concentration","deprecated":true,"href":"/api-reference/invoicing-concentration-insight/get-invoicing-concentration"},{"title":"Insight Export","openapi":"get /entities/{entityId}/insights/{insight}/export","href":"/api-reference/insights/export-an-insight"}]},{"group":"Reports","pages":[{"openapi":"get /reports","title":"List all reports","description":"List the reports available to the authenticated user: built-in reports, the user's personal reports, and organizational reports.\n\nInsight entries whose feature flags are not enabled for your organization are omitted from the `insights` layout.\n","href":"/api-reference/reports/list-reports"},{"openapi":"post /reports","title":"Create a report","href":"/api-reference/reports/create-a-report"},{"openapi":"get /reports/{id}","title":"Retrieve a report","description":"Retrieve a report by ID. Use the report ID as the `uri` path segment when requesting a PDF download with the [Exports API](/api-reference/exports/export-data).\n","href":"/api-reference/reports/retrieve-a-report"},{"openapi":"put /reports/{id}","title":"Update a report","href":"/api-reference/reports/update-a-report"},{"openapi":"delete /reports/{id}","title":"Delete a report","href":"/api-reference/reports/delete-a-report"}]},{"group":"Webhooks","pages":[{"group":"Webhook Endpoints","pages":[{"openapi":"get /webhook-endpoints","title":"List webhook endpoints","href":"/api-reference/webhook-endpoints/list-all-webhook-endpoints"},{"openapi":"post /webhook-endpoints","title":"Create webhook endpoint","href":"/api-reference/webhook-endpoints/create-a-webhook-endpoint"},{"openapi":"get /webhook-endpoints/{id}","title":"Retrieve webhook endpoint","href":"/api-reference/webhook-endpoints/retrieve-a-webhook-endpoint"},{"openapi":"put /webhook-endpoints/{id}","title":"Update webhook endpoint","href":"/api-reference/webhook-endpoints/update-an-webhook-endpoint"},{"openapi":"delete /webhook-endpoints/{id}","title":"Delete webhook endpoint","href":"/api-reference/webhook-endpoints/delete-a-webhook-endpoint"}]},{"group":"Webhook Requests","pages":[{"openapi":"get /webhook-requests","title":"List webhook requests","href":"/api-reference/webhook-requests/list-all-webhook-requests"},{"openapi":"get /webhook-requests/{id}","title":"Retrieve webhook request","href":"/api-reference/webhook-requests/retrieve-a-webhook-request"}]}]}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},{"language":"es","pages":[{"title":"es","href":"/es"}]}]},"title":"Create a report - Syntage","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","Page-D5fEM6aW.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}