Get Daily Group Visibility

GET

https://apigw.seomonitor.com/v3/rank-tracker/v3.0/groups/daily-visibility

Retrieves the daily Visibility and average weighted ranks of your website or of any other domain, for a group of keywords, over a specified timeframe.

You can use this endpoint in two ways:

to retrieve the Visibility data of an existing keyword group created in the SEOmonitor campaign, by specifying the group_id in the request.

to retrieve the Visibility data of a list of requested keywords, by specifying the list of keyword_ids in the request.

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

integer

optional

The ID for the group of keywords for which the data must be returned.

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

string

optional

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

Please refer to the Quick Start Guide to learn how 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:

domain

string

optional

The domain name for which the Visibility will be returned.

If no domain is provided, the endpoint will return the data for the campaign's website.

Example:

feature_visibility

string

optional

This parameter enables you to also retrieve the Visibility for one of the following SERP features:
product_listing

images_pack

questions

ads_pack

knowledge_graph

top_stories

local_pack

featured_snippet

recipes

news

If no feature_visibility is specified, the endpoint will return an empty array.

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/groups/daily-visibility?campaign_id={{campaign_id}}&start_date={{start_date}}&end_date={{end_date}}&group_id={{group_id}}&keyword_ids={{keyword_ids}}&domain={{domain}}&feature_visibility={{feature_visibility}}' \
--header 'Accept: application/json' \
--header 'Authorization;'

Responses

🟢200Group daily visibility data.

application/json

Body

date

string

optional

The date within the requested timeframe for which Visibility metrics are returned.

visibility

object

optional

Parent field containing the desktop and mobile Visibility metrics of the requested domain for the date specified.

desktop

number

optional

The desktop Visibility of the requested domain.

mobile

number

optional

The mobile Visibility of the requested domain.

avg_rank

object

optional

Parent field containing the average desktop and mobile ranks of the keywords weighted by their search volume, for the date specified.

desktop

integer

optional

The average rank of the keywords in the specified group weighted by their search volume, for searches coming from desktop devices.

mobile

integer

optional

The average rank of the keywords in the specified group weighted by their search volume, for searches coming from mobile devices.

feature_visibility

object

optional

Parent field containing the Visibility for the requested SERP feature, for the date specified.

desktop

number

optional

The desktop SERP feature Visibility.

mobile

number

optional

The mobile SERP feature Visibility.

Example

[
    {
        "date": "2023-08-01",
        "visibility": {
            "desktop": 0.53,
            "mobile": 0.51
        },
        "avg_rank": {
            "desktop": 11.2,
            "mobile": 12.3
        },
        "feature_visibility": {
            "desktop": 20.1,
            "mobile": 0
        }
    }
]

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

Get Daily Keyword Ranks

Add New Keywords