Get Daily Share of Clicks

GET

https://apigw.seomonitor.com/v3/rank-tracker/v3.0/daily-share-of-clicks

Retrieves the daily share of clicks of your domain and the top ten ones by visibility, on a specific keyword list, for the selected timeframe.

You can use this endpoint in two ways:

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

to retrieve the Share of Clicks 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

optional

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

Example:

2024-01-01

end_date

string

optional

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

Example:

2024-01-02

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:

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/daily-share-of-clicks?campaign_id={{campaign_id}}&start_date=2024-01-01&end_date=2024-01-02&group_id={{group_id}}&keyword_ids={{keyword_ids}}' \
--header 'Accept: application/json' \
--header 'Authorization;'

Responses

🟢200Success

application/json

Body

date

string

optional

The date within the requested timeframe for which the Share of Clicks metrics are returned.

domains

object

optional

Parent field containing the Share of Clicks metrics of the requested domain, for the date specified.

domain

string

optional

The domain sharing clicks with the campaign domain.

share_of_clicks

number

optional

The percentage of the estimated monthly share of clicks the domain receives for the current list of keywords.

monthly_clicks

integer

optional

The estimated monthly clicks the domain receives for the current list of keywords.

Example

[
  {
    "date": "2023-08-01",
    "domains": [
      {
        "domain": "amazon.com",
        "share_of_clicks": 0.53,
        "monthly_clicks": 2345000
      },
      {
        "domain": "etsy.com",
        "share_of_clicks": 0.43,
        "monthly_clicks": 19345000
      }
    ]
  }
]

Modified at 2024-12-13 13:08:36

Get Ranking Pages

Get Daily Traffic Data by Segment