搜索可见性观测结果列表

搜索可见性观测结果列表。新购额度包按全部关键词与来源组合相加：Google/Bing 的 Top10/20/50 各消耗 1/2/5 额度，Baidu 各消耗 10/20/50；Google 高级操作符乘以 5。年付含120,000 credits，月付含10,000 credits；读取免费。旧调用包创建报告或任务各计1次。

当前接口契约

接口详情：https://www.gugudata.com/api/details/search-visibility

请求参数

参数	类型	必填	默认值	说明
appkey	string	否	无	咕咕数据开发者中心分配的 APPKEY。 AppKey 整体必填；在本操作已声明支持的鉴权位置任选一个提供，本位置无需重复填写。多处填写时须一致。
runId	string	是	无	观测任务 ID。
pageSize	integer	否	20	每页数量；0 使用默认值 20。
pageToken	string	否	无	分页令牌。
filter	string	否	无	过滤表达式。报告列表支持 brand/domain；任务列表支持 state；结果列表支持 source/query。
orderBy	string	否	无	排序表达式，如 createdAt desc、updatedAt desc、checkedAt desc。

正常响应

HTTP 200，application/json。

字段	类型	说明
results	object[]
nextPageToken	string

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

搜索观测资源。

Bodyapplication/json

示例

{
    "results": [
        {
            "name": "string",
            "runId": "string",
            "reportId": "string",
            "searchMetadata": {
                "checkUrl": "string",
                "serpFeatures": {
                    "hasPaid": true,
                    "hasLocalPack": true,
                    "hasRelatedSearches": true,
                    "hasImages": true,
                    "hasPeopleAlsoAsk": true,
                    "hasVideo": true,
                    "hasFeaturedSnippet": true
                },
                "itemTypes": [
                    "string"
                ],
                "itemsCount": 0,
                "totalResults": 0
            },
            "resultId": "string",
            "source": "string",
            "metrics": {
                "visibilityScore": 0,
                "bestRank": 0,
                "bestCompetitorRank": 0,
                "matchedUrlCount": 0,
                "competitorGap": 0,
                "visible": true,
                "averageRankWithPenalty": 0,
                "top20": true,
                "top10": true
            },
            "checkedAt": "2019-08-24T14:15:22.123Z",
            "competitorMatches": [
                {
                    "url": "string",
                    "registrableDomain": "string",
                    "title": "string",
                    "domain": "string",
                    "competitorName": "string",
                    "competitorDomain": "string",
                    "rank": 0
                }
            ],
            "observedItems": [
                {
                    "resultType": "string",
                    "source": "string",
                    "rank": 1,
                    "url": "string",
                    "snippet": "string",
                    "rankAbsolute": 0,
                    "title": "string",
                    "rankGroup": 0,
                    "domain": "string",
                    "displayUrl": "string"
                }
            ],
            "query": "string",
            "brandMatches": [
                {
                    "url": "string",
                    "registrableDomain": "string",
                    "title": "string",
                    "domain": "string",
                    "rank": 0
                }
            ],
            "cacheHit": true
        }
    ],
    "nextPageToken": "string"
}

🟠400INVALID_ARGUMENT

🟠401UNAUTHENTICATED

🟠403PERMISSION_DENIED

🟠404NOT_FOUND

🟠429RESOURCE_EXHAUSTED

🔴500INTERNAL

🔴503UNAVAILABLE

当前接口契约#

请求参数#

正常响应#

请求参数

请求示例代码

返回响应

当前接口契约

请求参数

正常响应