An unexpected error occurred on the server. If this persists, contact support.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Mindshare AI","colors":{"primary":"#8B5CF6","light":"#A78BFA","dark":"#7C3AED"},"logo":{"light":"https://mintcdn.com/mindshare/rDFI1T0ZDib06cKe/logo/light1.svg?fit=max\u0026auto=format\u0026n=rDFI1T0ZDib06cKe\u0026q=85\u0026s=af7e774d5fe9f7d2d94066a2d2a6d844","dark":"https://mintcdn.com/mindshare/rDFI1T0ZDib06cKe/logo/dark1.svg?fit=max\u0026auto=format\u0026n=rDFI1T0ZDib06cKe\u0026q=85\u0026s=e92a97221227d914fb8d06354c812db2","href":"https://www.mindshare.so/"},"favicon":"https://mintcdn.com/mindshare/rDFI1T0ZDib06cKe/favicon.svg?fit=max\u0026auto=format\u0026n=rDFI1T0ZDib06cKe\u0026q=85\u0026s=00edc15dfc48c6d94f1e48602216d74b","navbar":{"links":[{"href":"mailto:ethan@mindshare.so","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.amionai.com/login"}},"footer":{"socials":{"website":"https://www.mindshare.so","linkedin":"https://www.linkedin.com/company/mindshareai"}},"integrations":{"gtm":{"tagId":"GTM-WB238KWS"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"mindshare","hasAudioNarration":false,"actualSubdomain":"mindshare","customDomains":["docs.mindshare.so"],"gitSource":{"type":"github","owner":"pelegaran","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21e8a9cf44a63d52c9b7d7","collectionId":"e9c82730-3366-465c-96e1-13a887ca6909","schemaVersion":"v2"},"entitlements":{},"buildId":"6a21e8a9cf44a63d52c9b7d7:success","clientVersion":"0.0.3869","searchFilterCounts":[{"language":"default","tag":"Mindshare API","count":21},{"language":"default","tag":"Endpoints","count":16},{"language":"default","tag":"Data Retrieval","count":10},{"language":"default","tag":"Management","count":5},{"language":"default","tag":"API documentation","count":4},{"language":"default","tag":"Utilities","count":1},{"language":"default","tag":"Use Cases","count":1}]},"assistantConfig":{"enableStarterQuestions":false},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"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":"editor-branches-v2-autocommit","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-branches-v2","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":"teamspace","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":"vite-origin","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":"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":"revalidation-jwt","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":"client-snapshot-docs-config","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/response-codes","slug":"/api-reference/response-codes","pageMetadata":{"title":"Response Codes","description":null,"href":"/api-reference/response-codes"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,hr:`hr`,p:`p`,..._provideComponents(),...props.components},{Heading}=_components;if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`The API uses standard HTTP response codes to indicate the success or failure of requests. Here are the most common error codes you may encounter.`}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`success-codes`,children:`Success Codes`}),`\n`,_jsx(Heading,{level:`3`,id:`200-ok`,children:_jsx(_components.code,{children:`200 OK`})}),`\n`,_jsx(_components.p,{children:`The request was successful and the response contains the requested data.`}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`server-error-codes`,children:`Server Error Codes`}),`\n`,_jsx(Heading,{level:`3`,id:`400-bad-request`,children:_jsx(_components.code,{children:`400 Bad Request`})}),`\n`,_jsx(_components.p,{children:`The request was malformed or contains invalid parameters. Check your request body and parameters.`}),`\n`,_jsx(Heading,{level:`3`,id:`401-unauthorized`,children:_jsx(_components.code,{children:`401 Unauthorized`})}),`\n`,_jsx(_components.p,{children:`Authentication failed or API key is missing. Verify your API key is correct and included in the request header.`}),`\n`,_jsx(Heading,{level:`3`,id:`403-forbidden`,children:_jsx(_components.code,{children:`403 Forbidden`})}),`\n`,_jsx(_components.p,{children:`The API key doesn’t have permission to access the requested resource. Contact support if you believe this is an error.`}),`\n`,_jsx(Heading,{level:`3`,id:`429-too-many-requests`,children:_jsx(_components.code,{children:`429 Too Many Requests`})}),`\n`,_jsxs(_components.p,{children:[`Rate limit exceeded. Wait until the rate limit window resets before making additional requests. See `,_jsx(_components.a,{href:`/api-reference/rate-limits`,children:`Rate Limits`}),` for details.`]}),`\n`,_jsx(Heading,{level:`3`,id:`500-internal-server-error`,children:_jsx(_components.code,{children:`500 Internal Server Error`})}),`\n`,_jsx(_components.p,{children:`An unexpected error occurred on the server. If this persists, contact support.`}),`\n`,_jsx(_components.hr,{})]})}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":{"title":"Response Codes","description":null,"href":"/api-reference/response-codes"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Success Codes","slug":"success-codes","depth":2,"children":[{"title":"200 OK","slug":"200-ok","depth":3,"children":[]}]},{"title":"Server Error Codes","slug":"server-error-codes","depth":2,"children":[{"title":"400 Bad Request","slug":"400-bad-request","depth":3,"children":[]},{"title":"401 Unauthorized","slug":"401-unauthorized","depth":3,"children":[]},{"title":"403 Forbidden","slug":"403-forbidden","depth":3,"children":[]},{"title":"429 Too Many Requests","slug":"429-too-many-requests","depth":3,"children":[]},{"title":"500 Internal Server Error","slug":"500-internal-server-error","depth":3,"children":[]}]}],"codeExamples":{}},"jsLinks":[],"subdomain":"mindshare","siteName":"Mindshare AI","title":"Response Codes - Mindshare AI","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-04-19T08:31:23.759Z","originalFileLocation":"api-reference/response-codes.mdx"},"headHtml":"\u003cmeta data-mint-head name=\"application-name\" content=\"Mindshare AI\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/mindshare/_zIwOFSRnCXMRrAH/_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/mindshare/_zIwOFSRnCXMRrAH/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/mindshare/_zIwOFSRnCXMRrAH/_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/mindshare/_zIwOFSRnCXMRrAH/_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/mindshare/_zIwOFSRnCXMRrAH/_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/mindshare/_zIwOFSRnCXMRrAH/_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/mindshare/_zIwOFSRnCXMRrAH/_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/mindshare/_zIwOFSRnCXMRrAH/_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/mindshare/_zIwOFSRnCXMRrAH/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Response Codes - Mindshare AI\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Mindshare AI\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.mindshare.so/api-reference/response-codes\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Response Codes - Mindshare AI\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/mindshare/_zIwOFSRnCXMRrAH/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Mindshare AI\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#8B5CF6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.mindshare.so/api-reference/response-codes\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/response-codes.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.mindshare.so/#organization\",\"name\":\"Mindshare AI\",\"url\":\"https://docs.mindshare.so\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/mindshare/rDFI1T0ZDib06cKe/logo/light1.svg?fit=max\u0026auto=format\u0026n=rDFI1T0ZDib06cKe\u0026q=85\u0026s=af7e774d5fe9f7d2d94066a2d2a6d844\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.mindshare.so#website\",\"name\":\"Mindshare AI\",\"url\":\"https://docs.mindshare.so\",\"publisher\":{\"@id\":\"https://docs.mindshare.so/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.mindshare.so/api-reference/response-codes#webpage\",\"url\":\"https://docs.mindshare.so/api-reference/response-codes\",\"name\":\"Response Codes\",\"dateModified\":\"2026-04-19T08:31:23.759Z\",\"isPartOf\":{\"@id\":\"https://docs.mindshare.so#website\"},\"breadcrumb\":{\"@id\":\"https://docs.mindshare.so/api-reference/response-codes#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.mindshare.so/api-reference/response-codes#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API documentation\",\"item\":\"https://docs.mindshare.so/api-reference/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Response Codes\",\"item\":\"https://docs.mindshare.so/api-reference/response-codes\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.mindshare.so/api-reference/response-codes#article\",\"headline\":\"Response Codes\",\"name\":\"Response Codes\",\"url\":\"https://docs.mindshare.so/api-reference/response-codes\",\"mainEntityOfPage\":{\"@id\":\"https://docs.mindshare.so/api-reference/response-codes#webpage\"},\"dateModified\":\"2026-04-19T08:31:23.759Z\",\"publisher\":{\"@id\":\"https://docs.mindshare.so/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.mindshare.so#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Mindshare AI\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Mindshare AI","nav":{"global":null,"tabs":[{"tab":"Mindshare API","groups":[{"group":"API documentation","pages":[{"title":"Introduction","description":null,"href":"/api-reference/introduction"},{"title":"Authentication","description":null,"href":"/api-reference/authentication"},{"title":"Rate Limits","description":null,"href":"/api-reference/rate-limits"},{"title":"Response Codes","description":null,"href":"/api-reference/response-codes"}]},{"group":"Endpoints","pages":[{"group":"Data Retrieval","pages":[{"title":"Get Org Customers","openapi":"POST /get-organization-customers","description":"Retrieve a list of all customers associated with the organization.\n\nThis endpoint provides detailed information including customer account status, trial periods, payment status, and scan schedules.","href":"/api-reference/endpoint/get-organization-customers"},{"title":"Get Org Quota Status","openapi":"POST /get-organization-quota-status","description":"Returns the organization's query group quota, how many are currently in use, and a per-customer breakdown of active query groups.","href":"/api-reference/endpoint/get-organization-quota-status"},{"title":"Get Query Groups","openapi":"POST /get-customer-query-groups","description":"Retrieve query groups associated with a customer.\nA query group represents a set of related queries for a specific product line or campaign. Customers can have multiple query groups.\n\nThis endpoint returns keywords, scan location, and a complete history of all scans with their scores and dates.","href":"/api-reference/endpoint/get-customer-query-groups"},{"title":"Get Queries","openapi":"POST /get-queries","description":"This endpoint returns a comprehensive list of queries with complete answer analysis, including whether your customer appears in the answers, the full answer text, competitors mentioned in responses, and all sources cited in the answers.\n\nUse either queryGroupID with a date range for historical data, or executionID to get results from a specific scan.\n\nResults include executions from all supported AI platforms (e.g. ChatGPT, Google AI Overview) by default.","href":"/api-reference/endpoint/get-queries"},{"title":"Get Queries Definitions","openapi":"POST /get-queries-definitions","description":"Returns the list of query definitions (prompts) for a given query group.\n\nA query group represents a set of related queries for a specific product line or campaign. This endpoint returns the queries themselves — not execution results. To get execution results with resources, competitors, and scores, use `POST /get-queries` instead.\n\nThe caller must own the query group through their organization.","href":"/api-reference/endpoint/get-queries-definitions"},{"title":"Get Companies Stats","openapi":"POST /get-companies-stats","description":"This endpoint returns aggregated data showing which companies appear in query results. For each company, you'll receive:\n\nCount: How many queries this company was mentioned in\nPercentage: What percent of total queries this company was mentioned in\n\nUse either queryGroupID with a date range for historical analysis, or executionID to get statistics from a specific scan.\n\nResults include executions from all supported AI platforms (e.g. ChatGPT, Google AI Overview) by default.","href":"/api-reference/endpoint/get-companies-stats"},{"title":"Get Domain Stats","openapi":"POST /get-domain-stats","description":"This endpoint returns two datasets:\n\n**Domain Stats**: Shows which domains appear in query results\nCount: How many queries this domain was mentioned in\nPercentage: What percent of total queries this domain appeared in\nCategory: Domain category classification\n\n**Article Stats**: Shows which specific articles appear in query results\nCount: How many queries this article was appear in. \nPercentage: What percent of total queries this article appeared in\nisCustomerMentioned: Indicator whether your customer is mentioned inside the article.\n\nResults include executions from all supported AI platforms (e.g. ChatGPT, Google AI Overview) by default.","href":"/api-reference/endpoint/get-domain-stats"},{"title":"Get Recommendations","openapi":"POST /get-recommendations","description":"Retrieve weekly strategic recommendations for improving brand visibility.\n\nOur system provides data-driven recommendations that help you increase your presence in AI-generated responses. Each recommendation includes:\n\nWhy it's relevant, platform where the recommendation should be executed (Reddit, blog, YouTube, etc.), references to third-party sources currently influencing AI engines, and a direct action URL when applicable.\n\nNote: Google AI Overview is not yet supported here — at the moment all recommendations are generated based on ChatGPT visibility data only.","href":"/api-reference/endpoint/get-recommendations"},{"title":"Get Customer Growth Stats","openapi":"POST /get-customer-growth-stats","description":"This endpoint provides data organized by query group, with two distinct views:\n\n**Per Scan**: Shows individual scores for each scan with its date. Provides granular, point-in-time data for each scan. Includes execution date and score for each scan\n\n**Overview**: Shows 30-day rolling average scores. Provides smoothed trend data that reduces noise. Calculated as rolling averages based on the last 30 days of executions — computed per AI platform.\n\nResults include executions from all supported AI platforms (e.g. ChatGPT, Google AI Overview) by default.","href":"/api-reference/endpoint/get-customer-growth-stats"},{"title":"Get Execution Status","openapi":"POST /get-execution-status","description":"Returns the status and progress of a scan execution. Use this to poll whether an execution has completed, track how many queries have been processed, and get an estimated time of completion for in-progress scans.","href":"/api-reference/endpoint/get-execution-status"}]},{"group":"Management","pages":[{"title":"Create Query Group","openapi":"POST /create-query-group","description":"Creates a new Query Group for a customer.\n\nA Query Group represents a set of related queries for a specific product line or campaign. Customers can have multiple Query Groups. For example, a cybersecurity company might have separate Query Groups for \"SASE\", \"Network Security\", and \"Endpoint Protection\", each tracking different keywords and AI visibility metrics independently.\n\nQuery Groups allow segmentation of AI visibility across product lines, geographies (e.g., \"UK-focused buying queries\" vs \"US-based comparisons\"), or verticals/use cases (e.g., \"Best AI tools for legal firms\" vs \"Best tools for startups\").\n\nOnce created, the system will begin tracking AI visibility for the provided keywords under this Query Group.\n\n**Note:** Creating a Query Group consumes one credit from the organization's quota.","href":"/api-reference/endpoint/create-query-group"},{"title":"Create Query Group From Existing","openapi":"POST /create-query-group-from-existing","description":"Creates a new Query Group by cloning an existing one.\n\nA Query Group represents a set of related queries for a specific product line or campaign. Customers can have multiple Query Groups. This endpoint allows duplicating a Query Group's configuration (website URL, keywords, language, country) under a new name, with the option to override any of those fields.\n\nIf the keywords remain the same as the parent, the system clones the existing queries for faster setup. If keywords are changed, the system generates new queries from scratch.\n\nThe parent Query Group must belong to the same customer.\n\n**Note:** Creating a Query Group consumes one credit from the organization's quota.","href":"/api-reference/endpoint/create-query-group-from-existing"},{"title":"Update Query Group Name","openapi":"POST /update-query-group-name","description":"Updates the name of an existing query group.\n\nA query group represents a set of related queries for a specific product line or campaign. Customers can have multiple query groups. The caller must own the query group through their organization.","href":"/api-reference/endpoint/update-query-group-name"},{"title":"Update Query Group Status","openapi":"POST /update-query-group-status","description":"Updates the status of an existing query group.\n\nA query group represents a set of related queries for a specific product line or campaign. Customers can have multiple query groups. The caller must own the query group through their organization — the system validates that the query group belongs to a customer within the caller's organization.\n\n**Note:** Changing status to **Active** consumes one credit from the organization's quota. Changing status to **Pause** or **Not Active** frees one credit back to the quota.","href":"/api-reference/endpoint/update-query-group-status"},{"title":"Edit Queries Definitions","openapi":"POST /edit-queries-definitions","description":"Adds and/or removes query definitions (prompts) from a query group.\n\nA query group represents a set of related queries for a specific product line or campaign. Customers can have multiple query groups. You can add new queries, remove existing ones, or both in a single call. At least one of `addedQueries` or `deletedQueriesIds` must contain values. The caller must own the query group through their organization.\n\n**Note:** Each query group is limited to a maximum of 150 active (non-deleted) queries.","href":"/api-reference/endpoint/edit-queries-definitions"}]},{"group":"Utilities","pages":[{"title":"Generate Keywords","openapi":"POST /generate-keywords","description":"Generates a list of 10 high-intent SEO keywords for a given website URL in the specified language.\n\nKeywords describe the product or services the website offers without including the business name. For local or niche businesses, keywords include the location or niche within each keyword.\n\nUses AI (GPT) to analyze the website and produce the list.","href":"/api-reference/endpoint/generate-keywords"}]}]},{"group":"Use Cases","pages":[{"title":"Agency Dashboard","description":"Build an agency dashboard with customer overview using the Mindshare API","href":"/use-cases/agency-dashboard"}]}]}]},"title":"Response Codes - Mindshare AI","buildId":"dpl_DMQXxPZd444kjahHSuSB7FkJbKrX","deploymentId":"dpl_DMQXxPZd444kjahHSuSB7FkJbKrX","dynamics":[],"chunks":[]}
