v1
latestOpenAPI 3.0.12026-07-2318588.1 KBWeb Pages
List Web Pages
Web page metrics are the daily metrics of citations, clicks, impressions, traffic, and configured GA4 key events for a specific web page.
post/public_api/brand_kits/{brand_kit_id}/web_pages/list
Path parameters
brand_kit_idinteger required
The Brand Kit ID
Request body
brand_kit_idinteger required
ID of the brand kit to retrieve web page metrics for
smart_filter'almost_page_one' | 'losing_clicks' | 'rankings_slipping' | 'losing_ai_visibility' | 'citation_rate_decline' | 'stale_pages'
Apply a predefined filter preset.
Available presets:
- almost_page_one: Pages ranking 10-20
- losing_clicks: Pages losing clicks despite stable rankings
- rankings_slipping: Pages declining in SERP
- losing_ai_visibility: Pages losing AI citations
- citation_rate_decline: Pages losing citation rate
- stale_pages: Pages not updated in 6 months
start_datestring
Start date for analysis period (ISO 8601 format, defaults to 1 month ago)
end_datestring
End date for analysis period (ISO 8601 format, defaults to today)
event_namesstring[]
Optional configured GA4 key event names to include. If omitted, all active key events configured for the brand kit are included.
amplitude_event_namesstring[]
Optional configured Amplitude event names to include. If omitted, all active Amplitude events configured for the brand kit are included when the feature is enabled.
fieldsstring[]
Select additional fields to return.
Optional fields:
- id: Unique identifier for the web page
- web_page_id: Web page ID (same as id)
- url: Full URL of the web page
- folder_name: First path segment of the URL (folder/section)
- primary_keyword: Primary keyword associated with this page
- citations_count: Number of citations this page received
- citations_count_diff: Percentage change in citations vs comparison period
- citation_rate: Ratio of citing answers to total answers with citations
- citation_rate_diff: Absolute change in citation rate vs comparison period
- prompts_count: Number of unique prompts citing this page
- prompts_count_diff: Change in prompts count vs comparison period
- clicks: Google Search Console clicks
- clicks_diff: Percentage change in clicks vs comparison period
- impressions: Google Search Console impressions
- impressions_diff: Percentage change in impressions vs comparison period
- ctr: Click-through rate (clicks/impressions)
- ctr_diff: Absolute change in CTR vs comparison period
- position: Average search position
- position_diff: Percentage change in position vs comparison period
- traffic: GA4 active users
- traffic_diff: Percentage change in traffic vs comparison period
- sessions: GA4 sessions count
- sessions_diff: GA4 Percentage change in sessions vs comparison period
- engagement: GA4 engaged sessions
- engagement_diff: GA4Percentage change in engagement vs comparison period
- average_session_engagement: GA4 Average session duration in seconds
- average_session_engagement_diff: GA4 Percentage change in average session duration vs comparison period
- events: Configured GA4 key events for this page. Each event includes event_name, event_count, and event_diff.
- amplitude_events: Configured Amplitude events for this page. Each event includes event_name, totals, and totals_diff.
sort'url' | '-url' | 'folder_name' | '-folder_name' | 'citations_count' | '-citations_count' | 'citations_count_diff' | '-citations_count_diff' | 'citation_rate' | '-citation_rate' | 'citation_rate_diff' | '-citation_rate_diff' | 'prompts_count' | '-prompts_count' | 'prompts_count_diff' | '-prompts_count_diff' | 'clicks' | '-clicks' | 'clicks_diff' | '-clicks_diff' | 'impressions' | '-impressions' | 'impressions_diff' | '-impressions_diff' | 'ctr' | '-ctr' | 'ctr_diff' | '-ctr_diff' | 'position' | '-position' | 'position_diff' | '-position_diff' | 'traffic' | '-traffic' | 'traffic_diff' | '-traffic_diff' | 'sessions' | '-sessions' | 'sessions_diff' | '-sessions_diff' | 'engagement' | '-engagement' | 'engagement_diff' | '-engagement_diff' | 'average_session_engagement' | '-average_session_engagement' | 'average_session_engagement_diff' | '-average_session_engagement_diff'
Sort field. Prefix with - for descending.
Available sort fields:
- url/-url: Sort alphabetically by URL
- folder_name/-folder_name: Sort alphabetically by folder name
- citations_count/-citations_count: Sort by citation count
- citations_count_diff/-citations_count_diff: Sort by citation change
- citation_rate/-citation_rate: Sort by citation rate
- citation_rate_diff/-citation_rate_diff: Sort by citation rate change
- prompts_count/-prompts_count: Sort by prompts count
- prompts_count_diff/-prompts_count_diff: Sort by prompts count change
- clicks/-clicks: Sort by GSC clicks
- clicks_diff/-clicks_diff: Sort by clicks change
- impressions/-impressions: Sort by GSC impressions
- impressions_diff/-impressions_diff: Sort by impressions change
- ctr/-ctr: Sort by click-through rate
- ctr_diff/-ctr_diff: Sort by CTR change
- position/-position: Sort by search position
- position_diff/-position_diff: Sort by position change
- traffic/-traffic: Sort by GA4 traffic
- traffic_diff/-traffic_diff: Sort by traffic change
- sessions/-sessions: Sort by GA4 sessions
- sessions_diff/-sessions_diff: Sort by sessions change
- engagement/-engagement: Sort by GA4 engagement
- engagement_diff/-engagement_diff: Sort by engagement change
- average_session_engagement/-average_session_engagement: Sort by avg session duration
- average_session_engagement_diff/-average_session_engagement_diff: Sort by avg session duration change
pageinteger
Page number
per_pageinteger
Items per page
Response
Successful response