SEOmonitor API 3.0
  1. Rank Tracker
SEOmonitor API 3.0
  • Overview
  • Campaigns
    • Get Tracked Campaigns
      GET
  • Rank Tracker
    • Get Keyword Data
      GET
    • Get Keyword AI Overview Data
      GET
    • Get Groups List
      GET
    • Get Keywords Competition Data
      GET
    • Get Top 100 Results
      GET
    • Get Groups Data
      GET
    • Get Daily Keyword Ranks
      GET
    • Get Daily Group Visibility
      GET
    • Add New Keywords
      POST
    • Get Keywords Import Status
      GET
    • Get Daily SERP Feature Presence
      GET
    • Get Ranking Pages
      GET
    • Get Daily Share of Clicks
      GET
  • Organic Traffic
    • Get Daily Traffic Data by Segment
      GET
    • Get Traffic Data by Keywords
      GET
  • Research
    • Keyword Research
      • By Topic
        • Get Related Keywords
        • Get Topic Overview
      • By URL/Domain
        • Get URL/Domain Overview
        • Get Ranking Keywords
      • Get Keyword Data
      • Get Ranking Data
    • Keyword Vault
      • Get Keyword Data by List
      • Get Overview Data
  • Forecast
    • Get Forecast scenarios
      GET
    • Get Forecast scenario Data
      GET
    • Get Forecast objective Data
      GET
    • Get Forecast keywords
      GET
  1. Rank Tracker

Get Keyword AI Overview Data

GET
https://apigw.seomonitor.com/v3/rank-tracker/v3.0/keywords/aio
This endpoint retrieves AI Overview content and links or AI Button 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.

Request

Authorization
Add parameter in header
Authorization
Example:
Authorization: ********************
Query Params
campaign_id
integer 
required
(Required) This parameter specifies the ID of the campaign for which you want to return data.
Please refer to the Quick Start Guide to learn how to retrieve the IDs of your campaigns.
Example:
{{campaign_id}}
start_date
string 
required
(Required) This parameter specifies the start date of the timeframe for which you want to return the ranking and traffic data in YYYY-MM-DD format.
If you don't specify astart_date, the default is 30 days before theend_date.
Example:
{{start_date}}
end_date
string 
required
(Required) This parameter specifies the end date of the timeframe for which you want to return the ranking and traffic data in YYYY-MM-DD format.
If you don't specify anend_date, the default is the current day.
Example:
{{end_date}}
group_id
string 
optional
The IDs of specific groups in the campaign to get keyword data for.
Please refer to the Quick Start Guide to learn how to retrieve the IDs of your groups.
If you do not specify agroup_id, the default value is the All Keywords group, which means data will be returned for all active keywords in the campaign.
Special Group IDs
There are several special IDs you can use to retrieve specific sets of keywords:
0: Retrieves data for all keywords.
-1: Specifies the Brand folder.
-2: Retrieves data for ungrouped keywords.
-3: Targets keywords associated with the Forecast objective
Example:
{{group_id}}
limit
integer 
optional
This parameter determines the maximum number of records to return in a single request.
Maximum Value: 1000 records per request
If you do not specify alimit, the default number of records returned per request will be 100.
Example:
{{limit}}
offset
integer 
optional
This parameter specifies the starting point within the collection of resource results. It's typically used with thelimit parameter to implement pagination.
If you do not specify anoffset, the API will start from the first record.
Example:
{{offset}}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://apigw.seomonitor.com/v3/rank-tracker/v3.0/keywords/aio?campaign_id={{campaign_id}}&start_date={{start_date}}&end_date={{end_date}}&group_id={{group_id}}&limit={{limit}}&offset={{offset}}' \
--header 'Authorization;'

Responses

🟢200Success
application/json
Body
array of:
keyword_id
integer 
optional
keyword
string 
optional
ai_data
object 
optional
desktop
array [object {3}] 
optional
mobile
array [object {3}] 
optional
Example
[
  {
    "keyword_id": 12365,
    "keyword": "Running Shoes",
    "ai_data": {
      "desktop": [
        {
          "date": "2024-01-01",
          "content": "",
          "links": []
        }
      ],
      "mobile": [
        {
          "date": "2024-01-01",
          "content": "",
          "links": []
        }
      ]
    }
  }
]
Previous
Get Keyword Data
Next
Get Groups List
Built with