Skip to main content
POST
/
get-customer-query-groups
cURL
curl --request POST \
  --url https://api.mindshare.so/customer/v1/get-customer-query-groups \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "customerID": 123
}
'
{
  "data": [
    {
      "query_group_id": 123,
      "group_type": "<string>",
      "created_time": "2023-11-07T05:31:56Z",
      "keywords": "<string>",
      "website_url": "<string>",
      "run_from_location": "<string>",
      "executions": [
        {
          "id": 123,
          "title": "<string>",
          "execution_date": "2023-12-25",
          "score": 123
        }
      ],
      "query_group_name": "<string>",
      "num_of_queries": 123
    }
  ],
  "version": "<string>",
  "env": "<string>"
}
Active — live, scanned on schedule, data available via API.Pause — scanning paused, still accessible via API, can be resumed.Not Active — fully disabled, no scanning, not available via API.
An execution is a single scan/run of all queries in a query group against an AI platform like ChatGPT, producing visibility scores, competitor mentions, and source citations for each query. Executions run periodically and their results over time power the growth tracking and trend analysis.

Authorizations

​
X-API-Key
string
header
required

Body

application/json

Customer ID

​
customerID
number
required

The ID of the customer

Response

200 - application/json

List of query groups for the customer

​
data
object[]
required

List of query groups

​
version
string
required

API version

​
env
string
required

Environment name