创建搜索可见性报告

POST

https://api.gugudata.com/v1/searchVisibilityReports

搜索可见性接口

创建搜索可见性报告并自动创建首个观测任务。该操作按关键词、搜索来源和排名深度消耗 credits。

接口详情官网地址: https://www.gugudata.com/api/details/search-visibility
请求方法: POST
接口路径: /v1/searchVisibilityReports
OpenAPI: https://www.gugudata.com/openapi/gugudata.openapi.3.1.json

为避免日常集合回归意外消耗 credits，默认跳过；显式设置 runSearchVisibilityMutations=true 后执行。

请求参数

Query 参数

Body 参数application/json必填

示例

{
    "brand": "",
    "domain": "",
    "queries": [],
    "sources": [],
    "displayName": "",
    "aliases": [],
    "competitors": [],
    "locale": "",
    "region": "",
    "maxRank": 20,
    "includeRawResponse": false
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --globoff 'https://api.gugudata.com/v1/searchVisibilityReports?appkey=请前往 https://www.gugudata.com 购买' \
--header 'Content-Type: application/json' \
--data '{
    "brand": "",
    "domain": "",
    "queries": [],
    "sources": [],
    "displayName": "",
    "aliases": [],
    "competitors": [],
    "locale": "",
    "region": "",
    "maxRank": 20,
    "includeRawResponse": false
}'

返回响应

🟢200成功

application/json

接口正常响应。请求成功，业务状态请结合响应体中的自定义业务码判断。

Bodyapplication/json

示例

{
    "name": "string",
    "reportId": "string",
    "displayName": "string",
    "brand": "string",
    "domain": "string",
    "aliases": [
        "string"
    ],
    "competitors": [
        {
            "domain": "string",
            "name": "string",
            "aliases": [
                "string"
            ]
        }
    ],
    "queries": [
        "string"
    ],
    "sources": [
        "string"
    ],
    "locale": "string",
    "region": "string",
    "maxRank": 0,
    "latestRunId": "string",
    "latestRunStatus": "string",
    "latestMetrics": {},
    "createdAt": "string",
    "updatedAt": "string"
}

🟠400

🟠401

🟠403

🟠404

🟠405

🟠415

🟠429

🔴500

🔴502

修改于 2026-07-29 04:54:09

获取搜索可见性观测结果

搜索可见性报告列表