Get Keyword Data by List - SEOmonitor API 3.0

This endpoint returns the SERP, search and ranking data for the keywords in a specified list within the Keyword Vault of a specified campaign. The ranking data is for the website tracked in the specified SEOmonitor campaign.

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:

list

string

required

(Required) The name of the list created in the Keyword Vault for which you want to return keyword data.

Example:

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:

order_by

string

optional

This parameter enables you to sort the returned data based on a specified field.

The field names you can use to sort data are:

search_volume

year-over-year

rank

rank_trend

percentage_clicks

If not otherwise specified, the returned data will be sorted by connection_strength by default.

Example:

order_direction

string

optional

This parameter determines the sorting direction of the order_by field. You can sort the data in either ascending (asc) or descending (desc) order.

If you do not specify an order_direction, the default is asc.

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:

include_unqualified

string

optional

This optional parameter controls whether unqualified keywords are included in the API response. By default, it is set to False, excluding unqualified keywords from the results. Set it to True to receive data for both qualified and unqualified keywords. Please note that data for unqualified keywords is not updated monthly.

Example:

domain

string

optional

This optional parameter - if provided - will return data for this particula competitor. If data is available. The domain should be in the form of a URL

Example:

Header Params

string

required

Example:

application/json

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

keyword

string

required

search_data

object

required

search_volume

string

required

year_over_year

string

required

monthly_searches

object

required

ranking_data

object

required

updated_on

string

required

rank

string

required

trend

string

required

landing_page

string

required

serp_data

object

required

percentage_clicks

string

required

serp_features

object

required

tracked_keyword_id

string

required

Example

{
  "keyword": "<string>",
  "search_data": {
    "search_volume": "<integer>",
    "year_over_year": "<double>",
    "monthly_searches": {
      "search_volume": "<integer>",
      "month": "<string>",
      "year": "<integer>"
    }
  },
  "ranking_data": {
    "updated_on": "<date>",
    "rank": "<integer>",
    "trend": "<integer>",
    "landing_page": "<string>"
  },
  "serp_data": {
    "percentage_clicks": "<number>",
    "serp_features": {
      "feature": "<string>",
      "position": "<integer>"
    }
  },
  "tracked_keyword_id": "<integer>"
}