Skip to main content
POST
/
api
/
analytics
/
fan-outs
/
by-query
/
{queryId}
Fan-outs for a specific query
curl --request POST \
  --url https://api.mentionlab.io/api/analytics/fan-outs/by-query/{queryId} \
  --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",
  "page": 1,
  "pageSize": 50
}
'
{
  "totalResponsesForQuery": 44,
  "fanOuts": [
    {
      "fanOutText": "HubSpot vs Salesforce pricing comparison",
      "occurrenceCount": 8,
      "rate": 18.18
    }
  ],
  "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

Path Parameters

queryId
string
required

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
page
number

Page number (1-based).

Example:

1

pageSize
number

Results per page. Default: 50, max: 200.

Example:

50

Response

200 - application/json
totalResponsesForQuery
number
required

Number of distinct AI responses for this query that produced at least one fan-out. Used as the denominator for the rate calculation.

Example:

44

fanOuts
object[]
required

Fan-outs for this query, ordered by occurrenceCount descending.

page
object
required

Pagination metadata.