Get Keyword AI Overview Data - SEOmonitor API 3.0

Authentication required. Set the Authorization header to your SEOmonitor API token (raw JWT — no Bearer prefix). See the Authentication Guide for setup.

This endpoint retrieves AI Overview content and citation links for a list of keywords part of a group, and their latest presence in a specific timeframe.

With this endpoint, you can get:
Campaign-wide Data: By default, this endpoint returns data for all active keywords in a specified campaign.

Group-specific Data: When you provide agroup_id, this endpoint will return data exclusively for the keywords within the specified group. Additionally, there are special group IDs which can access predefined groups. These are detailed further in the section on query parameters.

Keyword-specific Data: You can request data for specific keywords within a campaign by supplying their IDs using thekeyword_ids parameter.keyword_ids should be a comma-separated list of keyword IDs.

Note: Use other parameters likelimit,offset,order_by,order_direction, andsearch to further customize the data retrieval as per your needs.

Pagination. limit and offset page through the campaign's keyword list (all keywords in the campaign or group, in order_by order), not through the keywords that have an AI Overview. Keywords with no AI Overview stored for the requested timeframe are omitted from the page, so a page usually returns fewer rows than limit and the shortfall is not a gap. To list everything, advance offset by limit (not by the number of rows returned) until a page comes back empty. A keyword that never appears has no AI Overview data for the timeframe; pass its ID in keyword_ids to confirm.

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Bodyapplication/json

Example

{
    "keyword_id": "12365",
    "keyword": "Running Shoes",
    "sge_widget_data": {
        "desktop": {
            "2024-01-01": {
                "date": "2024-01-01",
                "links": [],
                "brand_presence": false,
                "brand_presence_any": false,
                "rank": 3
            }
        },
        "mobile": {
            "2024-01-01": {
                "date": "2024-01-01",
                "links": [],
                "brand_presence": false,
                "brand_presence_any": true,
                "rank": 5
            }
        }
    }
}