Skip to main content
GET
/
analytics
/
visitors
/
top-pages
Top Pages
curl --request GET \
  --url https://server.promptwatch.com/api/v2/analytics/visitors/top-pages \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "name": "<string>",
      "value": 123
    }
  ]
}

Authorizations

​
X-API-Key
string
header
required

API key for authentication. Get yours from the Promptwatch dashboard under Settings > API Keys.

Query Parameters

​
startDate
string<date>

Start date for analytics data (YYYY-MM-DD). Max range 60 days.

​
endDate
string<date>

End date for analytics data (YYYY-MM-DD). Max range 60 days.

​
referrerDomains

Filter by AI referrer domains (repeat param for multiple). Allowed: chatgpt.com, gemini.google.com, perplexity.ai, copilot.microsoft.com, copilot.com, claude.ai, grok.com, google.com, chat.mistral.ai

Available options:
chatgpt.com,
gemini.google.com,
perplexity.ai,
copilot.microsoft.com,
copilot.com,
claude.ai,
grok.com,
google.com,
chat.mistral.ai
​
timezone
string

IANA timezone for date bucketing (e.g., 'America/Los_Angeles')

​
path
string

Filter by specific page path

​
pathMatch
enum<string>

Path matching mode: 'exact' for exact match, 'partial' for prefix match (default: 'partial')

Available options:
exact,
partial
​
location
enum<string>

Filter by geographic location (ISO 3166-1 alpha-2 country code, e.g. US, GB, DE)

Available options:
AD,
AE,
AF,
AG,
AI,
AL,
AM,
AO,
AR,
AT,
AU,
AW,
AX,
AZ,
BA,
BB,
BD,
BE,
BF,
BG,
BH,
BI,
BJ,
BM,
BN,
BO,
BR,
BS,
BT,
BW,
BY,
BZ,
CA,
CD,
CF,
CG,
CH,
CI,
CL,
CM,
CN,
CO,
CR,
CU,
CV,
CW,
CY,
CZ,
DE,
DJ,
DK,
DM,
DO,
DZ,
EC,
EE,
EG,
ES,
ET,
FI,
FJ,
FM,
FO,
FR,
GA,
GB,
GD,
GE,
GF,
GG,
GH,
GI,
GL,
GM,
GN,
GP,
GQ,
GR,
GT,
GU,
GW,
GY,
HK,
HN,
HR,
HT,
HU,
ID,
IE,
IL,
IM,
IN,
IQ,
IR,
IS,
IT,
JE,
JM,
JO,
JP,
KE,
KG,
KH,
KN,
KR,
KW,
KY,
KZ,
LA,
LB,
LC,
LI,
LK,
LR,
LS,
LT,
LU,
LV,
LY,
MA,
MC,
MD,
ME,
MG,
MK,
ML,
MM,
MN,
MO,
MP,
MQ,
MR,
MT,
MU,
MV,
MW,
MX,
MY,
MZ,
NA,
NC,
NE,
NG,
NI,
NL,
NO,
NP,
NZ,
OM,
PA,
PE,
PF,
PG,
PH,
PK,
PL,
PR,
PS,
PT,
PY,
QA,
RE,
RO,
RS,
RU,
RW,
SA,
SC,
SD,
SE,
SG,
SI,
SK,
SL,
SN,
SO,
SR,
SS,
SV,
SX,
SZ,
TC,
TD,
TG,
TH,
TJ,
TM,
TN,
TR,
TT,
TW,
TZ,
UA,
UG,
US,
UY,
UZ,
VC,
VE,
VG,
VI,
VN,
XK,
YE,
YT,
ZA,
ZM,
ZW

Response

Default Response

​
data
object[]
required