DataKeywordMetricsVolumeFetch

Retrieve the most recent volume metric for any keyword that exists in our database.

JSON-RPC Method Name

data.keyword.metrics.volume.fetch

Request Parameters

serp_query

object

The SERP query object describes a keyword or search phrase in combination with several options to specify how the query is run (i.e. how a SERP should be retrieved for this keyword if necessary).

Response Values

keyword_metrics

object

Available metrics for a given keyword. In this action only volume will have a value, all other metrics will always be null.

serp_query

object

Represents a SERP query object.

Sample Request

1{
2  "serp_query": {
3    "keyword": "domain authority",
4    "locale": "en-US",
5    "device": "desktop",
6    "engine": "google"
7  }
8}

Sample Response

1{
2  "serp_query": {
3    "keyword": "domain authority",
4    "locale": "en-US",
5    "device": "desktop",
6    "engine": "google",
7    "vicinity": ""
8  },
9  "keyword_metrics": {
10    "volume": 2200,
11    "difficulty": null,
12    "organic_ctr": null,
13    "priority": null
14  }
15}

Quota Usage

Uses one row per call.

api.limits.data.rows

Example Code

curl -X POST https://api.moz.com/jsonrpc \
-H "x-moz-token: <YOUR_MOZ_TOKEN>" \
-H "Content-Type: application/json" \
-d '
{
  "jsonrpc": "2.0",
  "id": "e4eeab64-9298-4936-9433-94896e4d30f8",
  "method": "data.keyword.metrics.volume.fetch",
  "params": {
    "data": {
      "serp_query": {
        "keyword": "domain authority",
        "locale": "en-US",
        "device": "desktop",
        "engine": "google"
      }
    }
  }
}'