Skip to main content
POST
/
api
/
analytics
/
shopping
/
all-products
All products table (paginated, sortable)
curl --request POST \
  --url https://api.mentionlab.io/api/analytics/shopping/all-products \
  --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",
  "groupByEntityGroup": false,
  "entityTypes": [
    "owned",
    "primary",
    "competitor"
  ],
  "entityIds": [
    "<string>"
  ],
  "page": 1,
  "pageSize": 50,
  "sort": [
    {
      "field": "<string>",
      "direction": "ASC"
    }
  ]
}
'
{
  "totalShoppingResponses": 150,
  "products": [
    {
      "productId": "550e8400-e29b-41d4-a716-446655440000",
      "productName": "iPhone 15 Pro",
      "brandEntityId": "550e8400-e29b-41d4-a716-446655440001",
      "brandName": "Apple",
      "isOwned": true,
      "isPrimary": true,
      "isCompetitor": true,
      "visibility": 34,
      "merchants": [
        {
          "name": "Amazon",
          "domain": "amazon.com"
        }
      ],
      "avgPrice": 999,
      "avgRating": 4.5,
      "mentionCount": 42
    }
  ],
  "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"

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
groupByEntityGroup
boolean
default:false

When true, entities belonging to the same entity_group are collapsed into a single row. Uses COUNT(DISTINCT ai_response_id) so that two group members present in the same response count as one (visibility cannot exceed 100%).

entityTypes
enum<string>[]

Filter which entity types to include in results. Accepted values: "owned", "primary", "competitor". Defaults to all types when omitted.

Available options:
owned,
primary,
competitor
Example:
["owned", "primary", "competitor"]
entityIds
string[]

Entity IDs to filter products by brand (defaults to all non-blacklisted).

page
number
default:1

Page number (1-based).

pageSize
number
default:50

Items per page (max 200).

sort
object[]

Sort order. Allowed fields: productName, brandName, visibility, avgPrice, avgRating, mentionCount.

Response

200 - application/json
totalShoppingResponses
number
required

Total distinct AI responses with shopping products (denominator for visibility).

Example:

150

products
object[]
required

All products, sorted and paginated.

page
object
required

Pagination metadata.