相关页面

Reference example

# Fixed reference example. Playground inputs do not update this sample.
curl --request POST \
  --url https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/google/relevant_pages/live \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "target": "amazon.com",
    "language_name": "English",
    "location_code": 2840,
    "filters": [
      [
        "metrics.organic.pos_1",
        "<>",
        0
      ],
      "or",
      [
        "metrics.organic.pos_2_3",
        "<>",
        0
      ]
    ],
    "limit": 3
  }
]'

curl --request POST \
  --url https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/google/relevant_pages/live \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "filters": [
      [
        "metrics.organic.pos_1",
        "<>",
        0
      ],
      "or",
      [
        "metrics.organic.pos_2_3",
        "<>",
        0
      ]
    ],
    "language_name": "English",
    "limit": 3,
    "location_code": 2840,
    "target": "amazon.com"
  }
]
'

import requests

url = "https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/google/relevant_pages/live"

payload = [
    {
        "filters": [["metrics.organic.pos_1", "<>", 0], "or", ["metrics.organic.pos_2_3", "<>", 0]],
        "language_name": "English",
        "limit": 3,
        "location_code": 2840,
        "target": "amazon.com"
    }
]
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify([
    {
      filters: [['metrics.organic.pos_1', '<>', 0], 'or', ['metrics.organic.pos_2_3', '<>', 0]],
      language_name: 'English',
      limit: 3,
      location_code: 2840,
      target: 'amazon.com'
    }
  ])
};

fetch('https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/google/relevant_pages/live', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/google/relevant_pages/live",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'filters' => [
                [
                                'metrics.organic.pos_1',
                                '<>',
                                0
                ],
                'or',
                [
                                'metrics.organic.pos_2_3',
                                '<>',
                                0
                ]
        ],
        'language_name' => 'English',
        'limit' => 3,
        'location_code' => 2840,
        'target' => 'amazon.com'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/google/relevant_pages/live"

	payload := strings.NewReader("[\n  {\n    \"filters\": [\n      [\n        \"metrics.organic.pos_1\",\n        \"<>\",\n        0\n      ],\n      \"or\",\n      [\n        \"metrics.organic.pos_2_3\",\n        \"<>\",\n        0\n      ]\n    ],\n    \"language_name\": \"English\",\n    \"limit\": 3,\n    \"location_code\": 2840,\n    \"target\": \"amazon.com\"\n  }\n]")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/google/relevant_pages/live")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"filters\": [\n      [\n        \"metrics.organic.pos_1\",\n        \"<>\",\n        0\n      ],\n      \"or\",\n      [\n        \"metrics.organic.pos_2_3\",\n        \"<>\",\n        0\n      ]\n    ],\n    \"language_name\": \"English\",\n    \"limit\": 3,\n    \"location_code\": 2840,\n    \"target\": \"amazon.com\"\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/google/relevant_pages/live")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"filters\": [\n      [\n        \"metrics.organic.pos_1\",\n        \"<>\",\n        0\n      ],\n      \"or\",\n      [\n        \"metrics.organic.pos_2_3\",\n        \"<>\",\n        0\n      ]\n    ],\n    \"language_name\": \"English\",\n    \"limit\": 3,\n    \"location_code\": 2840,\n    \"target\": \"amazon.com\"\n  }\n]"

response = http.request(request)
puts response.read_body

{
  "cost": 123,
  "status_code": 123,
  "status_message": "<string>",
  "tasks_count": 123,
  "tasks_error": 123,
  "time": "<string>",
  "version": "<string>",
  "tasks": [
    {
      "cost": 123,
      "data": {},
      "id": "<string>",
      "path": [
        "<string>"
      ],
      "result_count": 123,
      "status_code": 123,
      "status_message": "<string>",
      "time": "<string>",
      "result": [
        {
          "items": [
            {
              "metrics": {},
              "page_address": "<string>",
              "se_type": "<string>"
            }
          ],
          "items_count": 123,
          "language_code": "<string>",
          "location_code": 123,
          "se_type": "<string>",
          "target": "<string>",
          "total_count": 123
        }
      ]
    }
  ]
}

POST

https://api.aisa.one

apis

dataforseo

dataforseo_labs

google

relevant_pages

live

Reference example

# Fixed reference example. Playground inputs do not update this sample.
curl --request POST \
  --url https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/google/relevant_pages/live \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "target": "amazon.com",
    "language_name": "English",
    "location_code": 2840,
    "filters": [
      [
        "metrics.organic.pos_1",
        "<>",
        0
      ],
      "or",
      [
        "metrics.organic.pos_2_3",
        "<>",
        0
      ]
    ],
    "limit": 3
  }
]'

curl --request POST \
  --url https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/google/relevant_pages/live \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "filters": [
      [
        "metrics.organic.pos_1",
        "<>",
        0
      ],
      "or",
      [
        "metrics.organic.pos_2_3",
        "<>",
        0
      ]
    ],
    "language_name": "English",
    "limit": 3,
    "location_code": 2840,
    "target": "amazon.com"
  }
]
'

import requests

url = "https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/google/relevant_pages/live"

payload = [
    {
        "filters": [["metrics.organic.pos_1", "<>", 0], "or", ["metrics.organic.pos_2_3", "<>", 0]],
        "language_name": "English",
        "limit": 3,
        "location_code": 2840,
        "target": "amazon.com"
    }
]
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify([
    {
      filters: [['metrics.organic.pos_1', '<>', 0], 'or', ['metrics.organic.pos_2_3', '<>', 0]],
      language_name: 'English',
      limit: 3,
      location_code: 2840,
      target: 'amazon.com'
    }
  ])
};

fetch('https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/google/relevant_pages/live', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/google/relevant_pages/live",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'filters' => [
                [
                                'metrics.organic.pos_1',
                                '<>',
                                0
                ],
                'or',
                [
                                'metrics.organic.pos_2_3',
                                '<>',
                                0
                ]
        ],
        'language_name' => 'English',
        'limit' => 3,
        'location_code' => 2840,
        'target' => 'amazon.com'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/google/relevant_pages/live"

	payload := strings.NewReader("[\n  {\n    \"filters\": [\n      [\n        \"metrics.organic.pos_1\",\n        \"<>\",\n        0\n      ],\n      \"or\",\n      [\n        \"metrics.organic.pos_2_3\",\n        \"<>\",\n        0\n      ]\n    ],\n    \"language_name\": \"English\",\n    \"limit\": 3,\n    \"location_code\": 2840,\n    \"target\": \"amazon.com\"\n  }\n]")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/google/relevant_pages/live")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"filters\": [\n      [\n        \"metrics.organic.pos_1\",\n        \"<>\",\n        0\n      ],\n      \"or\",\n      [\n        \"metrics.organic.pos_2_3\",\n        \"<>\",\n        0\n      ]\n    ],\n    \"language_name\": \"English\",\n    \"limit\": 3,\n    \"location_code\": 2840,\n    \"target\": \"amazon.com\"\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/google/relevant_pages/live")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"filters\": [\n      [\n        \"metrics.organic.pos_1\",\n        \"<>\",\n        0\n      ],\n      \"or\",\n      [\n        \"metrics.organic.pos_2_3\",\n        \"<>\",\n        0\n      ]\n    ],\n    \"language_name\": \"English\",\n    \"limit\": 3,\n    \"location_code\": 2840,\n    \"target\": \"amazon.com\"\n  }\n]"

response = http.request(request)
puts response.read_body

{
  "cost": 123,
  "status_code": 123,
  "status_message": "<string>",
  "tasks_count": 123,
  "tasks_error": 123,
  "time": "<string>",
  "version": "<string>",
  "tasks": [
    {
      "cost": 123,
      "data": {},
      "id": "<string>",
      "path": [
        "<string>"
      ],
      "result_count": 123,
      "status_code": 123,
      "status_message": "<string>",
      "time": "<string>",
      "result": [
        {
          "items": [
            {
              "metrics": {},
              "page_address": "<string>",
              "se_type": "<string>"
            }
          ],
          "items_count": 123,
          "language_code": "<string>",
          "location_code": 123,
          "se_type": "<string>",
          "target": "<string>",
          "total_count": 123
        }
      ]
    }
  ]
}

此端点将提供指定域名下网页的排名和流量数据。您可以查看每个页面的排名分布，以及来自自然搜索和付费搜索的预估月度流量。

示例

curl -X POST "https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/google/relevant_pages/live" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '[{"target": "...", "location_name": "...", "location_code": "..."}]'

// 把整段复制给 Claude Code、Codex、Cursor 或任意 coding agent。
// 连接、授权、跑通这个例子需要的东西都在里面 ——
// 不用粘贴任何 key，浏览器里点一次 Allow 就好。
{
  "calls": [
    {
      "call_id": "1",
      "tool": "post_dataforseo_labs_google_relevant_pages_live",
      "arguments": {}
    }
  ]
}
// ── for the agent ─────────────────────────────────────────────────────────
// Register the AIsa MCP server, then call its `batch_quote` tool with the JSON above.
//   name       aisa
//   endpoint   https://mcp.aisa.one/mcp
//   transport  streamable-http
//   auth       OAuth. The server publishes RFC 9728 metadata, so open a
//              browser and the user clicks Allow once — nothing to paste.
//              If AISA_API_KEY is set, send it as a bearer header instead.
// Use your own MCP mechanism, not a hand-edited config file:
//   Codex        codex mcp add aisa --url https://mcp.aisa.one/mcp
//   Claude Code  claude mcp add --transport http -s user aisa https://mcp.aisa.one/mcp
//   Cursor / VS Code   a "url" entry for https://mcp.aisa.one/mcp in the MCP config
// The server reaches https://mcp.aisa.one/servers worth of APIs through a few meta
// tools: search, list_categories, get_details, batch_quote, batch_use.
// search, get_details and batch_quote are free; batch_use is billed per
// call. This operation's full contract — every argument, the response
// shape, the price and the pitfalls — is at
//   https://aisa.one/docs/zh/api-reference/dataforseo/post_dataforseo-dataforseo-labs-google-relevant-pages-live.md
// Show me the quoted cost. Once I approve, run the same calls with
// batch_use and show me the result.

第一次用？ 把任意 MCP 客户端指向 https://mcp.aisa.one/mcp —— Claude Code、 Codex、Cursor、VS Code 都可以。鉴权走 OAuth：客户端打开浏览器，你点一次 Allow，不需要粘贴任何 key。之后智能体通过几个元工具调用所有端点： search、list_categories、get_details 和 batch_quote 免费，batch_use 按次计费。各客户端的接入步骤见通过 MCP 连接；实时工具列表和每次调用的价格见 aisa.one/zh-cn/mcp。

在你的 agent 里把这个端点跑起来 →

请求规范

方法与路径: POST /apis/v1/dataforseo/dataforseo_labs/google/relevant_pages/live
可用状态: enabled
请求 URL 模板: https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/google/relevant_pages/live
Runtime 事实版本: 6ab8fec17df1d5dcdff2e036dd1eb40587752b774ec040ab4eb0cc6946c3dd3c

完整 OpenAPI 定义有效请求与价格声明（包括认证和引用的 schema）：

{
  "operationId": "post_dataforseo_labs_google_relevant_pages_live",
  "method": "POST",
  "path": "/apis/v1/dataforseo/dataforseo_labs/google/relevant_pages/live",
  "servers": [
    {
      "url": "https://api.aisa.one"
    }
  ],
  "parameters": [],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "example": [
            {
              "filters": [
                [
                  "metrics.organic.pos_1",
                  "<>",
                  0
                ],
                "or",
                [
                  "metrics.organic.pos_2_3",
                  "<>",
                  0
                ]
              ],
              "language_name": "English",
              "limit": 3,
              "location_code": 2840,
              "target": "amazon.com"
            }
          ],
          "items": {
            "oneOf": [
              {
                "properties": {
                  "filters": {
                    "description": "<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code><p>example:<br><code>[\"metrics.paid.count\",\"&gt;\",0]</code><p><code>[[\"metrics.organic.count\",\"&gt;\",50],\"and\",[\"metrics.organic.pos_1\",\"&lt;&gt;\",0]]</code><p><code>[[\"\"metrics.organic.count\",\"&gt;\",50\"],<br>\"and\",<br>[[\"metrics.organic.pos_1\",\"&lt;&gt;\",0],\"or\",[\"metrics.organic.pos_2_3\",\"&lt;&gt;\",0]]]</code><br>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>",
                    "items": {
                      "anyOf": [
                        {
                          "type": "string"
                        },
                        {
                          "type": "number"
                        },
                        {
                          "type": "boolean"
                        },
                        {
                          "additionalProperties": {
                            "$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
                          },
                          "type": [
                            "object",
                            "null"
                          ]
                        },
                        {
                          "items": {
                            "$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
                          },
                          "type": "array"
                        }
                      ],
                      "description": "JSON representation of filter values and nested expressions. Field names, operators, condition counts and operand compatibility remain provider-validated as documented for each endpoint; this is not a complete filter-language validator."
                    },
                    "type": [
                      "array",
                      "null"
                    ]
                  },
                  "historical_serp_mode": {
                    "description": "<em>data collection mode</em><br>optional field<br>you can use this field to filter the results;<br>possible types of filtering:<br><code>live</code> — return metrics for SERPs in which the specified <code>target</code> currently has ranking results;<br><code>lost</code> — return metrics for SERPs in which the specified <code>target</code> had previously had ranking results, but didn't have them during the last check;<br><code>all</code> — return metrics for both types of SERPs.<br>default value: <code>live</code>",
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "ignore_synonyms": {
                    "description": "<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class=\"prettyprint\">true</code>, only core keywords will be returned, all highly similar keywords will be excluded;  <br>default value: <code>false</code>",
                    "type": [
                      "boolean",
                      "null"
                    ]
                  },
                  "include_clickstream_data": {
                    "description": "<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_etv</code>, <code>clickstream_gender_distribution</code>, and <code>clickstream_age_distribution</code> fields with clickstream data in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">help center article</a>",
                    "type": [
                      "boolean",
                      "null"
                    ]
                  },
                  "item_types": {
                    "description": "<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response<p><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response;<p>possible values: <br><code>[\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]</code><br>default value: <br><code>[\"organic\", \"paid\"]</code>",
                    "items": {
                      "type": "string"
                    },
                    "type": [
                      "array",
                      "null"
                    ]
                  },
                  "language_code": {
                    "description": "<em>language code</em><br>optional field<br>if you use this field, you don't need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">en</code>",
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "language_name": {
                    "description": "<em>full name of the language</em><br>optional field<br>if you use this field, you don't need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class=\"long-string\">English</code>",
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "limit": {
                    "description": "<em>the maximum number of returned pages</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>",
                    "type": [
                      "integer",
                      "null"
                    ]
                  },
                  "location_code": {
                    "description": "<em>location code</em><br>optional field<br>if you use this field, you don't need to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">2840</code>",
                    "type": [
                      "integer",
                      "null"
                    ]
                  },
                  "location_name": {
                    "description": "<em>full name of the location</em><br>optional field<br>if you use this field, you don't need to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class=\"long-string\">United Kingdom</code>",
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "offset": {
                    "description": "<em>offset in the results array of returned pages</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages",
                    "type": [
                      "integer",
                      "null"
                    ]
                  },
                  "order_by": {
                    "description": "<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to specify a sorting type<br>example:<br><code>[\"metrics.paid.etv,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request<br>you should use a comma to separate several sorting rules<br>example:<br><code>[\"metrics.organic.etv,desc\",\"metrics.paid.count,asc\"]</code><p>default rule:<br><code>[\"metrics.organic.count,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array",
                    "items": {
                      "type": "string"
                    },
                    "type": [
                      "array",
                      "null"
                    ]
                  },
                  "tag": {
                    "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "target": {
                    "description": "<em>domain</em><br><strong>required field</strong><br>the domain name of the target website<br>the domain should be specified without <code>https://</code> and <code>www.</code>",
                    "type": "string"
                  }
                },
                "type": "object"
              }
            ],
            "type": [
              "object",
              "null"
            ]
          },
          "type": "array"
        }
      }
    }
  },
  "x-aisa-status": "enabled",
  "x-aisa-pricing": {
    "cost_contract": "response_usd",
    "customer_multiplier": 1.0,
    "customer_pricing": "provider_cost_multiplier",
    "default_request_estimate_usd": 0.015,
    "estimate_source": "profile_seed",
    "evidence_source": "response_body"
  },
  "components": {
    "schemas": {
      "Provider0A3E90081762_AisaDataforseoFilterJsonValue": {
        "anyOf": [
          {
            "type": "string"
          },
          {
            "type": "number"
          },
          {
            "type": "boolean"
          },
          {
            "additionalProperties": {
              "$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
            },
            "type": [
              "object",
              "null"
            ]
          },
          {
            "items": {
              "$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
            },
            "type": "array"
          }
        ],
        "description": "JSON representation of filter values and nested expressions. Field names, operators, condition counts and operand compatibility remain provider-validated as documented for each endpoint; this is not a complete filter-language validator."
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "scheme": "bearer",
        "type": "http"
      }
    }
  }
}

费用与请求规则

按用量计费；默认请求预估费用：$0.015 USD（不是固定价格）。最终费用以账户适用价格及实际结算为准。公开参考值不是你的账户报价或最终扣费。对于支持 X-AISA-Cost-Mode: quote 的接口，执行前请针对完整请求获取免费报价；执行后通过响应费用元数据和 Usage Logs 核对结算费用。1 USD 等于 1,000,000 个整数 micro-USD。

默认请求参考估价（USD）: 0.015
计费依据: response_usd
公开参考倍率: 1.0
结算证据来源: response_body

授权

Authorization

string

header

必填

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

请求体

application/json

filters

array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:
regex, not_regex, <, <=, >, >=, =, <>, in, not_in

example:
["metrics.paid.count",">",0]

[["metrics.organic.count",">",50],"and",["metrics.organic.pos_1","<>",0]]

[[""metrics.organic.count",">",50"],"and",[["metrics.organic.pos_1","<>",0],"or",["metrics.organic.pos_2_3","<>",0]]]
for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide

JSON representation of filter values and nested expressions. Field names, operators, condition counts and operand compatibility remain provider-validated as documented for each endpoint; this is not a complete filter-language validator.

historical_serp_mode

string | null

data collection mode
optional field
you can use this field to filter the results;
possible types of filtering:
live — return metrics for SERPs in which the specified target currently has ranking results;
lost — return metrics for SERPs in which the specified target had previously had ranking results, but didn't have them during the last check;
all — return metrics for both types of SERPs.
default value: live

ignore_synonyms

boolean | null

ignore highly similar keywords
optional field
if set to true, only core keywords will be returned, all highly similar keywords will be excluded;
default value: false

include_clickstream_data

boolean | null

include or exclude data from clickstream-based metrics in the result
optional field
if the parameter is set to true, you will receive clickstream_etv, clickstream_gender_distribution, and clickstream_age_distribution fields with clickstream data in the response
default value: false
with this parameter enabled, you will be charged double the price for the request

learn more about how clickstream-based metrics are calculated in this help center article

item_types

string[] | null

display results by item type
optional field
indicates the type of search results included in the response

Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response;

possible values:
["organic", "paid", "featured_snippet", "local_pack"]
default value:
["organic", "paid"]

language_code

string | null

language code
optional field
if you use this field, you don't need to specify language_name
you can receive the list of available languages with their language_code by making a separate request to the
https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available languages
example:
en

language_name

string | null

full name of the language
optional field
if you use this field, you don't need to specify language_code
you can receive the list of available languages with their language_name by making a separate request to the
https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available languages
example:
English

limit

integer | null

the maximum number of returned pages
optional field
default value: 100
maximum value: 1000

location_code

integer | null

location code
optional field
if you use this field, you don't need to specify location_name
you can receive the list of available locations with their location_code by making a separate request to the
https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available locations
example:
2840

location_name

string | null

full name of the location
optional field
if you use this field, you don't need to specify location_code
you can receive the list of available locations with their location_name by making a separate request to the
https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available locations
example:
United Kingdom

offset

integer | null

offset in the results array of returned pages
optional field
default value: 0
if you specify the 10 value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages

order_by

string[] | null

results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:
asc - results will be sorted in the ascending order
desc - results will be sorted in the descending order
you should use a comma to specify a sorting type
example:
["metrics.paid.etv,asc"]
Note: you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules
example:
["metrics.organic.etv,desc","metrics.paid.count,asc"]

default rule:
["metrics.organic.count,desc"]
Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array

tag

string | null

user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response

target

string

domain
required field
the domain name of the target website
the domain should be specified without https:// and www.

示例:

[
  {
    "filters": [
      ["metrics.organic.pos_1", "<>", 0],
      "or",
      ["metrics.organic.pos_2_3", "<>", 0]
    ],
    "language_name": "English",
    "limit": 3,
    "location_code": 2840,
    "target": "amazon.com"
  }
]

响应

object | null

Successful operation

cost

number<double> | null

任务总成本（美元）

status_code

integer | null

general status code you can find the full list of the response codes here

status_message

string | null

general informational message you can find the full list of general informational messages here

tasks_count

integer<int64> | null

tasks 数组中的任务数量

tasks_error

integer<int64> | null

返回错误的 tasks 数组中的任务数量

time

string | null

total execution time, seconds

version

string | null

API 的当前版本

tasks

(object | null)[] | null

array of tasks

Show child attributes

概览

模型

搜索与研究

金融与加密

社交与媒体

SEO 与网站情报

销售与邮件

出行与其他

示例

请求规范

费用与请求规则

授权

请求体

响应

​示例

​请求规范

​费用与请求规则

授权

请求体

响应

示例

请求规范

费用与请求规则