Skip to main content
POST
/
api
/
v1
/
analytics
/
sources
/
domains
Source domains with citation & brand-reach metrics
curl --request POST \
  --url https://api.mentionlab.io/api/v1/analytics/sources/domains \
  --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",
  "entityIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "groupByEntityGroup": false,
  "limit": 50,
  "sort": [
    {
      "field": "citationShare",
      "direction": "desc"
    }
  ]
}
'
{
  "totalResponses": 365,
  "totalCitations": 712,
  "totalBrandPages": 200,
  "sources": [
    {
      "sourceDomainId": "01234567-89ab-cdef-0123-456789abcdef",
      "domain": "reddit.com",
      "resultCount": 102,
      "citationRate": 28,
      "citationShare": 14.3,
      "pageCount": 178,
      "brandPageCount": 45,
      "entityCitationShare": 22.5,
      "presence": 25.3,
      "brandResultCount": 38,
      "trueReach": 10.4
    }
  ]
}

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"

​
entityIds
string[]

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

Example:
["3fa85f64-5717-4562-b3fc-2c963f66afa6"]
​
groupByEntityGroup
boolean
default:false

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

Example:

false

​
limit
number

Max domains to return (omit for all)

Example:

50

​
sort
object[]

Sorting criteria applied to the returned domains. Each entry pairs a sortable field (e.g. domain, resultCount, citationRate, citationShare, pageCount, brandPageCount, entityCitationShare, presence, brandResultCount, trueReach) with a sort direction.

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

Response

​
totalResponses
number
required

Total number of AI responses in the filtered scope. Used as the denominator for citationRate.

Example:

365

​
totalCitations
number
required

Sum of resultCount across all source domains. Used as the denominator for citationShare. Note: this can exceed totalResponses because one response may cite multiple domains.

Example:

712

​
totalBrandPages
number
required

Sum of brandPageCount across all source domains. Used as the denominator for entityCitationShare.

Example:

200

​
sources
object[]
required

Per-domain statistics with all citation and brand reach metrics, ordered by resultCount descending (unless sorted).