Web Pages

List Web Pages

post

Web page metrics are the daily metrics of citations, clicks, impressions, traffic, and configured GA4 key events for a specific web page.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

brand_kit_idintegerRequired

The Brand Kit ID

Body

application/json

brand_kit_idintegerRequired

ID of the brand kit to retrieve web page metrics for

smart_filterstring · enumOptional

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

Possible values:

start_datestringOptional

Start date for analysis period (ISO 8601 format, defaults to 1 month ago)

end_datestringOptional

End date for analysis period (ISO 8601 format, defaults to today)

event_namesstring[]Optional

Optional configured GA4 key event names to include. If omitted, all active key events configured for the brand kit are included.

sortstring · enumOptional

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

Default: -citations_countPossible values:

pageintegerOptional

Page number

Default: 1

per_pageinteger · max: 100Optional

Items per page

Default: 25

Responses

200

Successful response

application/json

400

Bad request - invalid parameters, filters, or sort options

401

Unauthorized - invalid or missing authentication token

404

Not found - resource does not exist

412

Precondition failed - AEO not configured for this brand kit

post

/public_api/brand_kits/{brand_kit_id}/web_pages/list

HTTPcURLJavaScriptPython

POST /public_api/brand_kits/{brand_kit_id}/web_pages/list HTTP/1.1
Host: api.airops.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 237

{
  "brand_kit_id": 1,
  "smart_filter": "almost_page_one",
  "start_date": "text",
  "end_date": "text",
  "event_names": [
    "text"
  ],
  "filters": [
    {
      "field": "clicks",
      "operator": "EQ",
      "value": null
    }
  ],
  "fields": [
    "id"
  ],
  "sort": "-citations_count",
  "page": 1,
  "per_page": 25
}

{
  "data": [
    {
      "id": 1,
      "web_page_id": 1,
      "url": "text",
      "folder_name": "text",
      "primary_keyword": "text",
      "citations_count": 1,
      "citations_count_diff": 1,
      "citation_rate": 1,
      "citation_rate_diff": 1,
      "prompts_count": 1,
      "prompts_count_diff": 1,
      "clicks": 1,
      "clicks_diff": 1,
      "impressions": 1,
      "impressions_diff": 1,
      "ctr": 1,
      "ctr_diff": 1,
      "position": 1,
      "position_diff": 1,
      "traffic": 1,
      "traffic_diff": 1,
      "sessions": 1,
      "sessions_diff": 1,
      "engagement": 1,
      "engagement_diff": 1,
      "average_session_engagement": 1,
      "average_session_engagement_diff": 1,
      "events": [
        {}
      ]
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 1,
    "total_count": 1,
    "total_pages": 1,
    "data_availability": {
      "earliest_data_date": "text",
      "latest_data_date": "text",
      "requested_period_has_data": true
    }
  }
}