• API 功能

    • 按品牌、域名和关键词创建搜索观测报告;
    • 支持 Google、Bing 和百度搜索来源;
    • 可选择前 10、20 或 50 名观测范围;
    • 返回搜索结果标题、链接及可获取的摘要;
    • 支持品牌别名与竞品域名配置;
    • 展示品牌最佳排名及排名覆盖指标;
    • 提供竞品匹配与排名差距,便于对照分析;
    • 支持手动再次观测,并查询任务状态;
    • 按成功观测组合结算 credits,查询报告和结果不消耗搜索 credits;
    • 排名受时间、地区及搜索环境影响,不保证排名提升;
    • 默认最大 QPS:5,可在开发者中心自助升级;年度套餐包含 120,000 credits。
    • 接口调用状态与状态监控
  • API 文档

    接口地址: https://api.gugudata.com/v1/searchVisibilityReports

    返回格式: application/json; charset=utf-8

    请求方式: POST

    请求协议: HTTPS

    请求示例: https://api.gugudata.com/v1/searchVisibilityReports?appkey=APPKEY

    数据预览: https://www.gugudata.com/preview/search-visibility

    接口测试:  https://api.gugudata.com/v1/searchVisibilityReports/demo

    OpenAPI: https://www.gugudata.com/openapi/gugudata.openapi.3.1.json

    请求参数(POST 请求参数以 application/json 格式传递;鉴权方式请参见下方示例代码)

    参数名 参数类型 是否必须 默认值 备注
    appkey string 是 APPKEY 咕咕数据开发者中心分配的 APPKEY。建议通过 X-GUGUDATA-APPKEY、X-API-Key 或 Authorization: Bearer 传递;也兼容 Query 参数 appkey。
    brand string 是 品牌或产品名称,长度 1-120。用于匹配标题、摘要和结果链接中的品牌信号。
    domain string 是 需要观测的主域名,长度 1-255。可传 gugudata.com 或 https://www.gugudata.com,系统会按主域名规范化。
    queries array 是 需要观测的搜索关键词列表,1-50 个。创建报告会自动创建首个观测任务,按关键词数量计入 credits 计算。
    sources array 是 搜索来源,1-3 个;支持 google_web、bing_web、baidu_web。Google/Bing 在 maxRank=10/20/50 时分别消耗 1/2/5 credits;Baidu 同等排名深度消耗 10/20/50 credits。
    displayName string 否 报告显示名称,便于在列表中识别,不传时可由业务侧使用 brand/domain 展示。
    aliases array 否 品牌别名列表,最多 20 个;用于补充匹配英文名、简称、产品名等品牌信号。
    competitors array 否 竞品域名定义列表,最多 10 个;每项支持 domain、name、aliases,用于计算竞品排名和差距。
    locale string 否 语言区域提示,如 zh-CN、en-US。不同搜索来源会尽量按该提示观测。
    region string 否 地域提示,如 CN、US、HK。不同地域的排名可能不同。
    maxRank integer 否 20 观测排名深度,仅支持 10、20、50,默认 20。Google/Bing 分别消耗 1/2/5 credits,Baidu 分别消耗 10/20/50 credits。
    includeRawResponse boolean 否 false 是否在问题排查场景保留扩展返回引用。普通业务接入建议保持 false。

    返回参数

    参数名 参数类型 备注
    name string 报告资源名,格式为 searchVisibilityReports/{reportId}。
    reportId string 报告 ID,后续查询报告、创建观测任务时使用。
    displayName string 报告显示名称。
    brand string 品牌或产品名称。
    domain string 需要观测的主域名,系统会按规范域名返回。
    aliases array 品牌别名列表。
    competitors array 竞品定义列表,包含 domain、name、aliases。
    queries array 报告内需要持续观测的搜索关键词。
    sources array 搜索来源列表,支持 google_web、bing_web、baidu_web。
    locale string 语言区域提示,如 zh-CN、en-US。
    region string 地域提示,如 CN、US。
    maxRank integer 观测排名深度,仅支持 10、20、50。
    latestRunId string 最近一次观测任务 ID。创建报告时会自动创建首个观测任务。
    latestRunStatus string 最近一次观测任务状态,可能为 PENDING、RUNNING、SUCCEEDED、FAILED、PARTIALLY_FAILED、CANCELLED。
    latestMetrics object 最近一次观测任务聚合指标,任务完成前可能为空对象。
    createdAt string 报告创建时间,UTC RFC3339 格式。
    updatedAt string 报告最近更新时间,UTC RFC3339 格式。

    响应示例(真实数据节选)

    接口数据预览
    {
      "name": "searchVisibilityReports/svrpt_demo",
      "reportId": "svrpt_demo",
      "displayName": "咕咕数据搜索可见性观测",
      "brand": "咕咕数据",
      "domain": "gugudata.com",
      "aliases": [
        "GuGuData",
        "咕咕数据"
      ],
      "competitors": [
        {
          "domain": "example.com",
          "name": "示例竞品",
          "aliases": [
            "Example"
          ]
        }
      ],
      "queries": [
        "gugudata api",
        "咕咕数据 api"
      ],
      "sources": [
        "google_web",
        "bing_web"
      ],
      "locale": "zh-CN",
      "region": "CN",
      "maxRank": 20,
      "latestRunId": "svrun_demo",
      "latestRunStatus": "SUCCEEDED",
      "latestMetrics": {
        "visibilityScore": 0.86,
        "averageRank": 2.5,
        "top10QueryCount": 2,
        "observedQueryCount": 2,
        "observedResultCount": 4,
        "competitorMentionCount": 1,
        "sourceCount": 2
      },
      "createdAt": "2026-07-01T10:00:00Z",
      "updatedAt": "2026-07-01T10:05:00Z"
    }
  • 鉴权方式

    接口支持以下 AppKey 传递方式,任选一种即可;已有请求示例、Postman 集合和历史代码仍可继续使用原来的 appkey 参数方式。

    传输载体 参数 示例 说明
    HTTP Header X-GUGUDATA-APPKEY X-GUGUDATA-APPKEY: YOUR_APPKEY 推荐方式,适合服务端接入和统一封装。
    HTTP Header X-API-Key X-API-Key: YOUR_APPKEY 通用 API Key Header,便于和常见 API 客户端集成。
    HTTP Header Authorization Authorization: Bearer YOUR_APPKEY 适合 OpenAI 兼容接口或 Bearer Token 风格客户端。
    Query 参数 appkey ?appkey=YOUR_APPKEY 兼容现有示例、Postman 集合、浏览器调试和历史代码。

    部分历史 POST 接口仍兼容表单或 JSON body 中的 appkey;新接入建议优先使用 Header 或 Query 参数。

  • 接口常见 HTTP 响应状态码

    以下为接口调用中常见的 HTTP 传输层状态码,不等同于响应体内的业务状态码;完整状态码注册表以 IANA HTTP Status Code Registry 为准。

    状态码 状态码解释 备注
    200 请求成功 HTTP 请求已成功处理;业务状态请结合响应体中的自定义业务码判断。
    201 资源已创建 创建类接口请求成功,并已生成对应资源。
    202 请求已接受 请求已被接受处理,结果可能异步完成。
    204 无响应内容 请求成功但响应体为空,适用于无需返回数据的操作。
    400 请求参数错误 请求参数缺失、格式错误或参数组合不合法。
    401 认证失败 缺少、无效或未通过认证的访问凭证(如 AppKey)。
    403 无权限访问 订单到期、权限不足或接口额度不可用。
    404 资源不存在 请求路径不存在。
    405 请求方法不允许 当前路径不支持该 HTTP 方法。
    408 请求超时 客户端请求在服务端等待时间内未完成,可稍后重试。
    409 请求冲突 请求与当前资源状态冲突,调整参数或业务状态后重试。
    413 请求内容过大 上传文件或请求体超过接口限制。
    414 请求地址过长 请求 URL 超过服务端可处理长度,建议减少查询参数或改用 POST。
    415 请求内容类型不支持 上传或请求体的内容类型不符合接口要求。
    422 请求语义错误 请求格式正确,但参数取值、语义或业务约束无法处理。
    429 请求频率受限 默认按来源 IP 限速,单 IP 最多 5 QPS,可满足常规业务调用。超出限制时接口会返回 429 请求频率受限;已购买接口订单可加购 10 QPS 扩展。
    431 请求头过大 请求头字段过大或过多,建议精简 Header 后重试。
    500 服务器内部错误 服务端处理异常,请稍后重试。
    502 服务暂时不可用 请稍后重试。
    503 服务暂时不可用 请稍后重试。
    504 请求超时 请稍后重试。
  • 接口自定义业务状态码

    业务状态码 业务状态码解释 备注
    400 参数无效
    401 凭证缺失或无效
    403 权益不可用
    404 资源不存在
    429 频率或额度受限
    500 请求处理失败
    503 搜索服务暂不可用
  • 请求示例代码

    curl --location --request POST 'https://api.gugudata.com/v1/searchVisibilityReports?appkey=APPKEY' \
    --header 'Content-Type: application/json' \
    --data '{"displayName":"GuGuData brand visibility","brand":"GuGuData","domain":"gugudata.com","aliases":["GuGuData"],"competitors":[{"domain":"example.com","name":"Example","aliases":["Example"]}],"queries":["gugudata api"],"sources":["google_web"],"locale":"zh-CN","region":"CN","maxRank":10,"includeRawResponse":false}'
    #include <curl/curl.h>
    
    int main(void) {
      CURL *curl = curl_easy_init();
      if (curl) {
        curl_easy_setopt(curl, CURLOPT_URL, "https://api.gugudata.com/v1/searchVisibilityReports?appkey=APPKEY");
        curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "POST");
        curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L);
        struct curl_slist *headers = NULL;
        headers = curl_slist_append(headers, "Content-Type: application/json");
        curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
        curl_easy_setopt(curl, CURLOPT_POSTFIELDS, "{\"displayName\":\"GuGuData brand visibility\",\"brand\":\"GuGuData\",\"domain\":\"gugudata.com\",\"aliases\":[\"GuGuData\"],\"competitors\":[{\"domain\":\"example.com\",\"name\":\"Example\",\"aliases\":[\"Example\"]}],\"queries\":[\"gugudata api\"],\"sources\":[\"google_web\"],\"locale\":\"zh-CN\",\"region\":\"CN\",\"maxRank\":10,\"includeRawResponse\":false}");
        CURLcode res = curl_easy_perform(curl);
        (void)res;
        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
      }
      return 0;
    }
    
    using System;
    using System.Collections.Generic;
    using System.IO;
    using System.Net.Http;
    using System.Text;
    
    var client = new HttpClient();
    var request = new HttpRequestMessage(HttpMethod.Post, "https://api.gugudata.com/v1/searchVisibilityReports?appkey=APPKEY");
    request.Content = new StringContent("{\"displayName\":\"GuGuData brand visibility\",\"brand\":\"GuGuData\",\"domain\":\"gugudata.com\",\"aliases\":[\"GuGuData\"],\"competitors\":[{\"domain\":\"example.com\",\"name\":\"Example\",\"aliases\":[\"Example\"]}],\"queries\":[\"gugudata api\"],\"sources\":[\"google_web\"],\"locale\":\"zh-CN\",\"region\":\"CN\",\"maxRank\":10,\"includeRawResponse\":false}", Encoding.UTF8, "application/json");
    var response = client.SendAsync(request).Result;
    Console.WriteLine(response.Content.ReadAsStringAsync().Result);
    
    package main
    
    import (
      "strings"
      "fmt"
      "io"
      "net/http"
    )
    
    func main() {
      url := "https://api.gugudata.com/v1/searchVisibilityReports?appkey=APPKEY"
      payload := strings.NewReader("{\"displayName\":\"GuGuData brand visibility\",\"brand\":\"GuGuData\",\"domain\":\"gugudata.com\",\"aliases\":[\"GuGuData\"],\"competitors\":[{\"domain\":\"example.com\",\"name\":\"Example\",\"aliases\":[\"Example\"]}],\"queries\":[\"gugudata api\"],\"sources\":[\"google_web\"],\"locale\":\"zh-CN\",\"region\":\"CN\",\"maxRank\":10,\"includeRawResponse\":false}")
      req, err := http.NewRequest("POST", url, payload)
      if err != nil {
        fmt.Println(err)
        return
      }
      req.Header.Add("Content-Type", "application/json")
      res, err := http.DefaultClient.Do(req)
      if err != nil {
        fmt.Println(err)
        return
      }
      defer res.Body.Close()
      body, err := io.ReadAll(res.Body)
      if err != nil {
        fmt.Println(err)
        return
      }
      fmt.Println(string(body))
    }
    
    OkHttpClient client = new OkHttpClient().newBuilder().build();
    MediaType mediaType = MediaType.parse("application/json");
    RequestBody body = RequestBody.create(mediaType, "{\"displayName\":\"GuGuData brand visibility\",\"brand\":\"GuGuData\",\"domain\":\"gugudata.com\",\"aliases\":[\"GuGuData\"],\"competitors\":[{\"domain\":\"example.com\",\"name\":\"Example\",\"aliases\":[\"Example\"]}],\"queries\":[\"gugudata api\"],\"sources\":[\"google_web\"],\"locale\":\"zh-CN\",\"region\":\"CN\",\"maxRank\":10,\"includeRawResponse\":false}");
    Request request = new Request.Builder()
      .url("https://api.gugudata.com/v1/searchVisibilityReports?appkey=APPKEY")
      .method("POST", body)
      .build();
    Response response = client.newCall(request).execute();
    System.out.println(response.body().string());
    
    $.ajax({
      url: "https://api.gugudata.com/v1/searchVisibilityReports?appkey=APPKEY",
      method: "POST",
      contentType: "application/json",
      data: JSON.stringify({"displayName":"GuGuData brand visibility","brand":"GuGuData","domain":"gugudata.com","aliases":["GuGuData"],"competitors":[{"domain":"example.com","name":"Example","aliases":["Example"]}],"queries":["gugudata api"],"sources":["google_web"],"locale":"zh-CN","region":"CN","maxRank":10,"includeRawResponse":false}),
    }).done(function (response) {
      console.log(response);
    });
    
    const https = require("node:https");
    const url = "https://api.gugudata.com/v1/searchVisibilityReports?appkey=APPKEY";
    const body = JSON.stringify({"displayName":"GuGuData brand visibility","brand":"GuGuData","domain":"gugudata.com","aliases":["GuGuData"],"competitors":[{"domain":"example.com","name":"Example","aliases":["Example"]}],"queries":["gugudata api"],"sources":["google_web"],"locale":"zh-CN","region":"CN","maxRank":10,"includeRawResponse":false});
    
    const request = https.request(url, {
      method: "POST",
      headers: {
        "Content-Type": "application/json",
        "Content-Length": Buffer.byteLength(body)
      }
    }, handleResponse);
    request.on("error", console.error);
    request.write(body);
    request.end();
    
    function handleResponse(response) {
      const chunks = [];
      response.on("data", function (chunk) {
        chunks.push(chunk);
      });
      response.on("end", function () {
        console.log(Buffer.concat(chunks).toString("utf8"));
      });
    }
    
    #import <Foundation/Foundation.h>
    
    NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"https://api.gugudata.com/v1/searchVisibilityReports?appkey=APPKEY"]];
    [request setHTTPMethod:@"POST"];
    NSString *body = @"{\"displayName\":\"GuGuData brand visibility\",\"brand\":\"GuGuData\",\"domain\":\"gugudata.com\",\"aliases\":[\"GuGuData\"],\"competitors\":[{\"domain\":\"example.com\",\"name\":\"Example\",\"aliases\":[\"Example\"]}],\"queries\":[\"gugudata api\"],\"sources\":[\"google_web\"],\"locale\":\"zh-CN\",\"region\":\"CN\",\"maxRank\":10,\"includeRawResponse\":false}";
    [request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [request setHTTPBody:[body dataUsingEncoding:NSUTF8StringEncoding]];
    NSURLSessionDataTask *task = [[NSURLSession sharedSession] dataTaskWithRequest:request completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
      if (error) {
        NSLog(@"%@", error);
        return;
      }
      NSLog(@"%@", [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding]);
    }];
    [task resume];
    
    <?php
    $curl = curl_init();
    curl_setopt_array($curl, array(
      CURLOPT_URL => "https://api.gugudata.com/v1/searchVisibilityReports?appkey=APPKEY",
      CURLOPT_RETURNTRANSFER => true,
      CURLOPT_FOLLOWLOCATION => true,
      CURLOPT_CUSTOMREQUEST => "POST",
      CURLOPT_POSTFIELDS => "{\"displayName\":\"GuGuData brand visibility\",\"brand\":\"GuGuData\",\"domain\":\"gugudata.com\",\"aliases\":[\"GuGuData\"],\"competitors\":[{\"domain\":\"example.com\",\"name\":\"Example\",\"aliases\":[\"Example\"]}],\"queries\":[\"gugudata api\"],\"sources\":[\"google_web\"],\"locale\":\"zh-CN\",\"region\":\"CN\",\"maxRank\":10,\"includeRawResponse\":false}",
      CURLOPT_HTTPHEADER => array(
        "Content-Type: application/json",
      ),
    ));
    $response = curl_exec($curl);
    curl_close($curl);
    echo $response;
    
    import requests
    import json
    
    url = "https://api.gugudata.com/v1/searchVisibilityReports?appkey=APPKEY"
    payload = json.loads('{"displayName":"GuGuData brand visibility","brand":"GuGuData","domain":"gugudata.com","aliases":["GuGuData"],"competitors":[{"domain":"example.com","name":"Example","aliases":["Example"]}],"queries":["gugudata api"],"sources":["google_web"],"locale":"zh-CN","region":"CN","maxRank":10,"includeRawResponse":false}')
    response = requests.post(url, json=payload)
    print(response.text)
    
    require "uri"
    require "net/http"
    
    url = URI("https://api.gugudata.com/v1/searchVisibilityReports?appkey=APPKEY")
    https = Net::HTTP.new(url.host, url.port)
    https.use_ssl = true
    request = Net::HTTP::Post.new(url)
    request["Content-Type"] = "application/json"
    request.body = "{\"displayName\":\"GuGuData brand visibility\",\"brand\":\"GuGuData\",\"domain\":\"gugudata.com\",\"aliases\":[\"GuGuData\"],\"competitors\":[{\"domain\":\"example.com\",\"name\":\"Example\",\"aliases\":[\"Example\"]}],\"queries\":[\"gugudata api\"],\"sources\":[\"google_web\"],\"locale\":\"zh-CN\",\"region\":\"CN\",\"maxRank\":10,\"includeRawResponse\":false}"
    response = https.request(request)
    puts response.read_body
    
    import Foundation
    
    let semaphore = DispatchSemaphore(value: 0)
    var request = URLRequest(url: URL(string: "https://api.gugudata.com/v1/searchVisibilityReports?appkey=APPKEY")!, timeoutInterval: .infinity)
    request.httpMethod = "POST"
    request.addValue("application/json", forHTTPHeaderField: "Content-Type")
    request.httpBody = "{\"displayName\":\"GuGuData brand visibility\",\"brand\":\"GuGuData\",\"domain\":\"gugudata.com\",\"aliases\":[\"GuGuData\"],\"competitors\":[{\"domain\":\"example.com\",\"name\":\"Example\",\"aliases\":[\"Example\"]}],\"queries\":[\"gugudata api\"],\"sources\":[\"google_web\"],\"locale\":\"zh-CN\",\"region\":\"CN\",\"maxRank\":10,\"includeRawResponse\":false}".data(using: .utf8)
    let task = URLSession.shared.dataTask(with: request) { data, response, error in
      defer { semaphore.signal() }
      guard let data = data else {
        print(String(describing: error))
        return
      }
      print(String(data: data, encoding: .utf8)!)
    }
    task.resume()
    semaphore.wait()
    
  • 常见问题 Q&A

    • Q: Search Visibility 的 credits 怎么计算?

      A: 当前年度套餐包含 120,000 credits/年。credits = 关键词数量 × 各搜索来源单次消耗之和。Google/Bing 在 maxRank=10/20/50 时分别消耗 1/2/5 credits;Baidu 在 maxRank=10/20/50 时分别消耗 10/20/50 credits。例如 10 个关键词 × google_web × maxRank=20 消耗 20 credits;10 个关键词 × google_web + bing_web × maxRank=20 消耗 40 credits;10 个关键词 × baidu_web × maxRank=20 消耗 200 credits。创建报告会自动创建首个观测任务,之后手动创建观测任务也会消耗 credits;读取已有报告、任务和结果不消耗搜索可见性 credits。

    • Q: 报告、观测任务和观测结果有什么区别?

      A: 报告保存品牌、域名、关键词、来源和竞品配置;观测任务代表一次实际采样执行;观测结果是每个关键词和搜索来源的明细结果,包含排名、品牌匹配、竞品匹配和可见性指标。

    • Q: 任务状态应该如何轮询?

      A: 创建报告或观测任务后,可使用 runId 调用获取观测任务接口。当 state 为 SUCCEEDED 时表示全部完成;PARTIALLY_FAILED 表示部分关键词或来源失败,可继续读取成功结果并结合 errorSummary 判断是否重跑。

    • Q: 搜索可见性结果是否等同于官方搜索后台数据?

      A: 不是。该接口提供面向公开搜索结果的采样观测,适合做品牌词、关键词覆盖和竞品排名的自动化监控;如需站点所有权维度的点击、曝光和索引诊断,应结合搜索引擎官方后台数据一起判断。

    • Q: 如何完成第一次 API 调用?

      A: 先确认当前接口的请求方法、必填参数和成功状态,再使用对应产品的 AppKey 发起请求;以实际响应中的业务状态判断结果。 查看接入指南

    • Q: 如何保证请求时 AppKey 的安全性?

      A: 在开发者中心的 APP KEY 管理页面复制对应产品的 AppKey,并保存在服务端环境变量或密钥管理服务中。不要写入网页、App 客户端、公开仓库或日志。

    • Q: 接口可以用于哪些开发语言?

      A: Java、Python、Node.js、PHP、Go、C#、Swift、Kotlin 等支持 HTTP 请求的语言均可接入;也可以通过 OpenAPI、Postman 或 Apifox 查看和调试接口。

    • Q: 请求失败或超时后可以重试吗?

      A: 先区分 HTTP 状态与业务错误。参数、鉴权和权限错误应修正后再请求;超时并不表示服务端未执行,重试前需确认接口是否会重复计费或产生副作用。 查看接入指南

    • Q: 接口的性能可以保证吗?

      A: 实际响应时间受接口类型、参数和网络环境影响。请按当前套餐的 QPS 控制并发,生产接入前完成联调与容量评估。

  • 服务协议与免责声明

    购买或使用 GuGuData API 服务前,请充分阅读服务协议、免责声明与数据合规声明。相关页面均支持在浏览器中快速导出 PDF,便于内部归档、评审和合规留存。

  • 技术支持

    技术支持邮箱:
    support@gugudata.com
    企业微信客服:
    联系客服
  • 专业软件开发与系统工程服务

    GuGuData 官方认证工程合作伙伴,专注企业级数据接口集成、AI 工程化与大规模数据处理。团队深度理解 GuGuData 数据接口体系,具备海量数据采集、治理、检索与高并发接口服务经验,可围绕业务场景构建 AI Agent、MCP 接入、智能工作流和生产级数据应用,让数据能力稳定进入现有流程、内部平台和核心业务系统。

    了解工程服务