Skip to main content
POST
/
api
/
analytics
/
fan-outs
/
by-query
Fan-out stats per query (paginated)
curl --request POST \
  --url https://api.mentionlab.io/api/analytics/fan-outs/by-query \
  --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",
  "sort": [
    {
      "field": "<string>",
      "direction": "ASC"
    }
  ],
  "page": 1,
  "pageSize": 50
}
'
{
  "queries": [
    {
      "queryId": "550e8400-e29b-41d4-a716-446655440000",
      "queryText": "What is the best CRM software for small business?",
      "fanOutCount": 45,
      "uniqueFanOutCount": 18,
      "avgPerExecution": 3.2
    }
  ],
  "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
sort
object[]

Sort order. Allowed fields: fanOutCount, uniqueFanOutCount, avgPerExecution.

page
number

Page number (1-based).

Example:

1

pageSize
number

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

Example:

50

Response

200 - application/json
queries
object[]
required

Paginated list of queries that produced fan-outs, with per-query statistics.

page
object
required

Pagination metadata.