Skip to main content
POST
/
api
/
analytics
/
models
/
entity-visibility
Get entity visibility breakdown per AI model
curl --request POST \
  --url https://api.mentionlab.io/api/analytics/models/entity-visibility \
  --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>"
  ]
}
'
{
  "entities": [
    {
      "displayKey": "550e8400-e29b-41d4-a716-446655440000",
      "displayName": "Acme Corp",
      "isOwned": true,
      "isPrimary": true,
      "isCompetitor": false,
      "models": [
        {
          "model": "gpt-4o",
          "totalResponses": 500,
          "presentIn": 120,
          "visibilityPct": 24
        }
      ]
    }
  ]
}

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[]

Override entity IDs for visibility/SoV numerator (defaults to primary entities)

Response

200 - application/json
entities
object[]
required

Entity visibility matrix — each entity has a nested array of per-model visibility scores. Entities are ordered by display name, models by model name within each entity.