Skip to main content
POST
/
api
/
analytics
/
shopping
/
merchants
/
distribution
Merchant recommendation distribution
curl --request POST \
  --url https://api.mentionlab.io/api/analytics/shopping/merchants/distribution \
  --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",
  "limit": 10
}
'
{
  "totalMentions": 140,
  "merchants": [
    {
      "merchantId": "550e8400-e29b-41d4-a716-446655440000",
      "merchantName": "Amazon",
      "mentionCount": 45,
      "share": 32
    }
  ]
}

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
limit
number
default:10

Maximum number of merchants to return (1–100, default 10).

Response

200 - application/json
totalMentions
number
required

Sum of mentionCount across all merchants (denominator for share).

Example:

140

merchants
object[]
required

Top merchants by mention count, ordered descending.