Skip to main content
POST
Window overview of one prompt

Authorizations

Authorization
string
header
required

API key from Settings → Developer → API keys (prefix geom_). Each key is bound to one brand.

Body

application/json
prompt_id
string
required

Resource id for this API key brand.

Required string length: 1 - 64
time_range
enum<string>
default:30d
Available options:
7d,
30d,
custom
start_date
string

Start of a custom window (UTC+8 business day, YYYY-MM-DD).

Pattern: ^\d{4}-\d{2}-\d{2}$
end_date
string

End of a custom window (UTC+8 business day, YYYY-MM-DD).

Pattern: ^\d{4}-\d{2}-\d{2}$
platform
enum<string>
default:all
Available options:
all,
chatgpt,
perplexity,
gemini,
google_ai,
copilot,
google_ai_overview

Response

The prompt-overview report. data follows PromptOverviewReport when meta.schema_conformant is true.

data
object | null
required

The prompt-overview report. null only when meta.schema_conformant is false and the report output could not be mapped.

meta
object
required