Skip to main content
POST
/
get-companies-stats
cURL
curl --request POST \
  --url https://api.mindshare.so/customer/v1/get-companies-stats \
  --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": [
    {
      "company": "<string>",
      "count": 123,
      "percentage": 123
    }
  ],
  "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.

Stats are aggregated across all supported AI platforms by default — each company appears once with combined count and percentage across platforms. Response rows do not include an ai_platform field.Use the optional aiPlatform request parameter to scope stats to a single platform. Current values:
  • chatgpt — ChatGPT
  • aioverview — Google AI Overview
Additional platforms may be added in the future.When aiPlatform is set, count and percentage are recomputed relative to that platform only (i.e. percentage is over the filtered platform’s queries, not the total across all platforms).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 companies stats 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 stats to a single AI platform. Current values: 'chatgpt' (ChatGPT), 'aioverview' (Google AI Overview). Additional platforms may be added in the future. If omitted, stats are aggregated across all platforms. Not needed when 'executionID' is provided, since an execution already belongs to a single platform.

Response

200 - application/json

List of company statistics

​
data
object[]
required

List of company statistics

​
version
string
required

API version

​
env
string
required

Environment name