---
title: "Query Search Performance"
method: POST
path: "/v1/gdrive/search-console/search-analytics/query"
tags: ["Google Search Console"]
---

# Query Search Performance

`POST /v1/gdrive/search-console/search-analytics/query`

Queries clicks, impressions, CTR, and average position for a Search Console property.

## Query parameters

- `siteUrl` string, required

## Request body

- object
  - `startDate` string, date, required
  - `endDate` string, date, required
  - `dimensions` string[]
  - `type` 'web' | 'image' | 'video' | 'news' | 'discover' | 'googleNews'
  - `dimensionFilterGroups` object[]
  - `aggregationType` string
  - `dataState` string
  - `rowLimit` integer
  - `startRow` integer

## Response `200`

Search performance rows

- object
  - `rows` object[]
    - `keys` string[]
    - `clicks` number
    - `impressions` number
    - `ctr` number
    - `position` number
  - `responseAggregationType` string

## Other responses

- `400` — Bad request - Missing or invalid parameters
- `401` — Unauthorized - Invalid or missing API key
- `403` — Forbidden - The authenticated account cannot access this resource
- `412` — No Google account is connected
- `500` — Internal server error

---

[API](https://skmtc.dev/tryreplicas/apis/replica-api.md) · [All operations](https://skmtc.dev/tryreplicas/apis/replica-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/tryreplicas/replica-api/revisions/aa3b4c932f7a/schema)