Skip to main content
POST
aeo.mentions.summary

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
keyword
string

Topic to measure, e.g. project management software. Send keyword, domain or both.

Required string length: 1 - 256
domain
string

Website domain to measure, e.g. example.com. Send keyword, domain or both.

excludeDomains
string[]

Up to 9 domains whose answers are left out, e.g. a competitor's own site.

Required array length: 1 - 9 elements
platform
enum<string>

Which answer platform to measure: google or chatgpt.

Available options:
google,
chatgpt
country
string

Two-letter country code, like us. The chatgpt platform covers us only.

language
string

Two-letter language code, like en.

limit
number

How many rows to return, 1 to 50. Default 10.

Required range: x >= 1
cursor
string

Pass the previous result's nextCursor to get the next page.

Required string length: 1 - 64

Response

The result

results
object[]
required

The matching items.

nextCursor
string

Pass as cursor to get the next page; absent on the last page.