Skip to main content
POST
https://api.rankspot.ai
/
v1
/
gsc
/
performance
Get Search Console performance data
curl --request POST \
  --url https://api.rankspot.ai/v1/gsc/performance \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "startDate": "2024-01-01",
  "endDate": "2024-01-31",
  "dimensions": [
    "query"
  ],
  "dimensionFilterGroups": [
    {
      "filters": [
        {
          "dimension": "country",
          "expression": "ind",
          "operator": "equals"
        }
      ]
    }
  ],
  "startRow": 0,
  "rowLimit": 123
}
'

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
startDate
string
required

Start date in YYYY-MM-DD format

Example:

"2024-01-01"

​
endDate
string
required

End date in YYYY-MM-DD format

Example:

"2024-01-31"

​
dimensions
enum<string>[]

Dimensions to group by. Pass multiple times for combined grouping (e.g. query + page).

Available options:
query,
page,
country,
device,
date,
searchAppearance
Example:
["query"]
​
dimensionFilterGroups
object[]

Filter groups to narrow results. Filters within a group are ANDed together.

​
startRow
number

Zero-based index of the first row to return. Use with rowLimit for pagination.

Example:

0

​
rowLimit
number

Max rows to return (1–25000). Defaults to GSC API default (1000) when omitted.

Response

200 - application/json

Performance data from Google Search Console