Skip to main content
POST
/
get-queries
cURL
curl --request POST \
  --url https://api.mindshare.so/customer/v1/get-queries \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "customerID": 123,
  "queryGroupID": 123,
  "startDate": "2023-12-25",
  "endDate": "2023-12-25",
  "executionID": 123,
  "aiPlatform": "<string>"
}
'
{
  "data": [
    {
      "resources_data_path": "<string>",
      "date": "2023-11-07T05:31:56Z",
      "is_product_in_results": 123,
      "competitors_data_path": "<string>",
      "query": "<string>",
      "query_id": 123,
      "execution_id": 123,
      "ai_platform": "<string>",
      "query_results_path": "<string>"
    }
  ],
  "version": "<string>",
  "env": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.mindshare.so/llms.txt

Use this file to discover all available pages before exploring further.

Results include executions from all supported AI platforms by default. Each item in the response includes an ai_platform field so you can distinguish rows per platform.Use the optional aiPlatform request parameter to filter the response to a single platform. Current values:
  • chatgpt — ChatGPT
  • aioverview — Google AI Overview
Additional platforms may be added in the future.When executionID is provided, aiPlatform is not needed because an execution already belongs to a single platform.

Authorizations

X-API-Key
string
header
required

Body

application/json

Get queries parameters

customerID
number
required

The ID of the customer

queryGroupID
number

The ID of the query group

startDate
string<date>

Start date in yyyy-mm-dd format

endDate
string<date>

End date in yyyy-mm-dd format

executionID
number

The ID of the execution

aiPlatform
string

Optional. Filter results to a single AI platform. Current values: 'chatgpt' (ChatGPT), 'aioverview' (Google AI Overview). Additional platforms may be added in the future. If omitted, results from all platforms are returned. Not needed when 'executionID' is provided, since an execution already belongs to a single platform.

Response

200 - application/json

List of queries

data
object[]
required

List of queries

version
string
required

API version

env
string
required

Environment name