Skip to main content
POST
/
api
/
v1
/
analytics
/
shopping
/
merchants
List merchants with citation metrics
curl --request POST \
  --url https://api.mentionlab.io/api/v1/analytics/shopping/merchants \
  --header 'Content-Type: application/json' \
  --header 'x-project-id: <x-project-id>' \
  --data '
{
  "startDate": "2025-01-01",
  "endDate": "2025-02-01",
  "countries": [
    "BE",
    "FR"
  ],
  "languages": [
    "en",
    "fr"
  ],
  "models": [
    "gpt-4o",
    "claude-3-5-sonnet"
  ],
  "queryIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "queryTagIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "execTagIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "queryTagMode": "or",
  "execTagMode": "or",
  "timezone": "Europe/Brussels",
  "page": 1,
  "pageSize": 50,
  "entityIds": [
    "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  ],
  "groupByEntityGroup": false,
  "merchantName": "amazon",
  "sort": [
    {
      "field": "citationShare",
      "direction": "DESC"
    }
  ]
}
'
{
  "totalResponses": 365,
  "totalMerchantCitations": 450,
  "totalBrandMentions": 200,
  "merchants": [
    {
      "merchantId": "550e8400-e29b-41d4-a716-446655440000",
      "merchantName": "Amazon",
      "domain": "amazon.com",
      "mentionCount": 45,
      "citationRate": 28,
      "citationShare": 15,
      "entityCitationShare": 22.5,
      "trueReach": 40,
      "aboveFoldShare": 62.5,
      "avgPosition": 2.4,
      "freeShippingShare": 40,
      "avgShippingPrice": 4.95,
      "inStockShare": 95
    }
  ],
  "page": {
    "totalRecords": 123,
    "limit": 123,
    "currentPage": 123,
    "totalPages": 123,
    "nextPage": 123,
    "prevPage": 123
  }
}

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"

​
countries
string[]

Filter by country codes

Example:
["BE", "FR"]
​
languages
string[]

Filter by language codes

Example:
["en", "fr"]
​
models
string[]

Filter by AI models

Example:
["gpt-4o", "claude-3-5-sonnet"]
​
queryIds
string[]

Filter by query IDs

Example:
["3fa85f64-5717-4562-b3fc-2c963f66afa6"]
​
hasSources
enum<string>

Filter by source presence: "sources" (only with sources), "no_sources" (only without), "all" (no filter). Legacy true/false values are still accepted.

Available options:
all,
sources,
no_sources
​
hasShopping
enum<string>

Filter by shopping presence: "shopping" (only with shopping), "no_shopping" (only without), "all" (no filter). Legacy true/false values are still accepted.

Available options:
all,
shopping,
no_shopping
​
queryTagIds
string[]

Filter by query tag IDs

Example:
["3fa85f64-5717-4562-b3fc-2c963f66afa6"]
​
execTagIds
string[]

Filter by execution tag IDs

Example:
["3fa85f64-5717-4562-b3fc-2c963f66afa6"]
​
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
​
timezone
string
default:UTC

IANA timezone for date bucketing and filtering (e.g. "Europe/Brussels"). Defaults to UTC.

Example:

"Europe/Brussels"

​
page
number
default:1

Page number (1-based).

Example:

1

​
pageSize
number
default:50

Items per page (max 200).

Example:

50

​
entityIds
string[]

Entity IDs for brand-specific metrics (defaults to primary non-blacklisted).

Example:
["a1b2c3d4-e5f6-7890-abcd-ef1234567890"]
​
groupByEntityGroup
boolean
default:false

When true, expand selected entities to include all members of their entity groups.

Example:

false

​
merchantName
string

Case-insensitive substring match on merchant name.

Example:

"amazon"

​
sort
object[]

Sort order. Allowed fields: merchantName, citationRate, citationShare, entityCitationShare, trueReach, mentionCount.

Example:
[
  {
    "field": "citationShare",
    "direction": "DESC"
  }
]

Response

​
totalResponses
number
required

Total AI responses in filtered scope (denominator for citationRate).

Example:

365

​
totalMerchantCitations
number
required

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

Example:

450

​
totalBrandMentions
number
required

Sum of brand-matched mention counts across all merchants (denominator for entityCitationShare).

Example:

200

​
merchants
object[]
required

Merchant list, sorted and paginated.

​
page
object
required

Pagination metadata.