Get Daily SERP Feature Presence

GET

https://apigw.seomonitor.com/v3/rank-tracker/v3.0/keywords/serp-feature-presence

This endpoint returns the historical daily SERP feature data for specified keywords over a specified timeframe.

It provides a comprehensive timeline view of the different SERP features present for each keyword on desktop and mobile searches. This includes detailed tracking of whether the website being monitored is listed in each detected feature per date.

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:

start_date

string

required

(Required) This parameter specifies the start date of the timeframe for which you want to return the data in YYYY-MM-DD format.

Example:

end_date

string

required

(Required) This parameter specifies the end date of the timeframe for which you want to return the data in YYYY-MM-DD format.

Example:

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 a group_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:

keyword_ids

array[string]

optional

This parameter allows you to specify the IDs of the keywords for which you want to return data. keyword_ids should be a comma-separated list of keyword IDs.

Please refer to the keyword-related endpoints in our API to retrieve the IDs of your keywords.

If you do not specify keyword_ids, the API will return data for all keywords that meet the other specified criteria (e.g. group_id).

Example:

["{{keyword_ids}}"]

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 a limit, the default number of records returned per request will be 100.

Example:

offset

integer

optional

This parameter specifies the starting point within the collection of resource results. It's typically used with the limit parameter to implement pagination.

If you do not specify an offset, the API will start from the first record.

Example:

string

optional

The search parameter allows you to filter the results based on a keyword search. The API will return only those records where the keyword matches (fully or partially) the provided search term.
The search parameter is case-insensitive, allowing partial matches irrespective of casing.

Example:

Header Params

string

required

Example:

application/json

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request GET 'https://apigw.seomonitor.com/v3/rank-tracker/v3.0/keywords/serp-feature-presence?campaign_id={{campaign_id}}&start_date={{start_date}}&end_date={{end_date}}&group_id={{group_id}}&keyword_ids={{keyword_ids}}&limit={{limit}}&offset={{offset}}&search={{search}}' \
--header 'Accept: application/json' \
--header 'Authorization;'

Responses

🟢200Success

application/json

Body

keyword_id

integer

optional

The unique ID used to identify and reference the keyword in the system. It can be stored and used in other endpoints for filtering.

keyword

string

optional

The name of the keyword.

serp_data

array [object {3}]

optional

Parent field containing the data for SERP features present on the keyword for each day of the selected timeframe, for each device. Please refer to the Quick Start Guide for the complete feature name of each abbreviation.

date

string

optional

The date within the selected timeframe when the SERP features were detected.

desktop

array [object {2}]

optional

Parent field containing the features present in the desktop SERP on the returned date.

mobile

array [object {2}]

optional

Parent field containing the SERP features detected on searches from mobile devices.

Example

[
    {
        "keyword_id": 123,
        "keyword": "cars",
        "serp_data": [
            {
                "date": "2023-08-01",
                "desktop": [
                    {
                        "feature": "AIO",
                        "listed": true
                    },
                    {
                        "feature": "AIB",
                        "listed": false
                    },
                    {
                        "feature": "IMG",
                        "listed": false
                    }
                ],
                "mobile": [
                    {
                        "feature": "AIO",
                        "listed": true
                    },
                    {
                        "feature": "AIB",
                        "listed": false
                    },
                    {
                        "feature": "IMG",
                        "listed": false
                    }
                ]
            }
        ]
    }
]

Modified at 2024-12-13 13:07:59

Get Keywords Import Status

Get Ranking Pages