Skip to main content
POST
/
api
/
analytics
/
shopping
/
overview
Shopping overview stats
curl --request POST \
  --url https://api.mentionlab.io/api/analytics/shopping/overview \
  --header 'Content-Type: application/json' \
  --header 'x-project-id: <x-project-id>' \
  --data '
{
  "startDate": "2025-01-01",
  "endDate": "2025-02-01",
  "country": "<string>",
  "language": "<string>",
  "models": [
    "<string>"
  ],
  "hasSources": true,
  "hasShopping": true,
  "queryTagIds": [
    "<string>"
  ],
  "execTagIds": [
    "<string>"
  ],
  "queryTagMode": "or",
  "execTagMode": "or"
}
'
{
  "shoppingCoverage": 34.5,
  "identifiedBrands": 12,
  "identifiedProducts": 87,
  "identifiedMerchants": 8
}

Headers

​
x-project-id
string
required

Project ID to specify the project context

Body

application/json
​
startDate
string

Start date (inclusive)

Example:

"2025-01-01"

​
endDate
string

End date (exclusive)

Example:

"2025-02-01"

​
country
string

Filter by country code

​
language
string

Filter by language code

​
models
string[]

Filter by AI models

​
hasSources
boolean

Filter by responses that have sources

​
hasShopping
boolean

Filter by responses that have shopping products

​
queryTagIds
string[]

Filter by query tag IDs

​
execTagIds
string[]

Filter by execution tag IDs

​
queryTagMode
enum<string>
default:or

Query tag matching mode: "or" matches ANY tag (default), "and" matches ALL tags.

Available options:
and,
or
​
execTagMode
enum<string>
default:or

Execution tag matching mode: "or" matches ANY tag (default), "and" matches ALL tags.

Available options:
and,
or

Response

200 - application/json
​
shoppingCoverage
number | null
required

Shopping coverage — percentage of all AI responses that contain shopping/product content. Formula: (responses with has_shopping=true / totalResponses) × 100.

Example:

34.5

​
identifiedBrands
number
required

Number of unique brands (entities) identified in shopping results. Only counts products where entity resolution has completed.

Example:

12

​
identifiedProducts
number
required

Number of unique products identified in shopping results. Only counts products where product resolution has completed.

Example:

87

​
identifiedMerchants
number
required

Number of unique merchants/retailers found in shopping results.

Example:

8