Metrics

Google Search Console metrics via API

Your customer connects their Google Search Console account and your product queries 12 metrics through the same endpoint as every other platform. Each metric has an id (reference_key) that goes in the request.

POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>

{
  "customer_integration": "<connection uuid>",
  "start": "2026-10-01",
  "end": "2026-10-31",
  "comparison_start": "2026-09-01",
  "comparison_end": "2026-09-30",
  "metrics": [
    {
      "id": "m1",
      "reference_key": "search_console:clicks",
      "component": "number_v1",
      "metrics": [
        "clicks"
      ]
    }
  ]
}
Example: "Clicks" in October, compared to September.

More Google Search Console request examples

The same endpoint for every kind of metric. The metrics and dimensions of each item come from the platform catalog (GET /api/metrics/{integration_slug}).

Chart

Position and CTR Evolution

The graph describes the evolution of position and CTR over the analysed period.

POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>

{
  "customer_integration": "<connection uuid>",
  "start": "2026-10-01",
  "end": "2026-10-31",
  "metrics": [
    {
      "id": "m1",
      "reference_key": "search_console:ctr_and_position_over_time",
      "component": "chart_v1",
      "metrics": [
        "ctr",
        "position"
      ],
      "dimensions": [
        "date"
      ]
    }
  ]
}

Table

Featured Keywords

Statistics of your site, grouped by the query and sorted by clicks. These are the queries that returned your site as a response to a search.

POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>

{
  "customer_integration": "<connection uuid>",
  "start": "2026-10-01",
  "end": "2026-10-31",
  "metrics": [
    {
      "id": "m1",
      "reference_key": "search_console:query",
      "component": "datatable_v1",
      "metrics": [
        "clicks",
        "impressions",
        "ctr",
        "position"
      ],
      "dimensions": [
        "query"
      ]
    }
  ]
}

Number

Impressions

How many links to your site a user saw on Google search results.

POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>

{
  "customer_integration": "<connection uuid>",
  "start": "2026-10-01",
  "end": "2026-10-31",
  "metrics": [
    {
      "id": "m1",
      "reference_key": "search_console:impressions",
      "component": "number_v1",
      "metrics": [
        "impressions"
      ]
    }
  ]
}

Numbers

4 metrics

  • Clicks

    Number of clicks on Google's result page that led to your website.

    search_console:clicks
  • Impressions

    How many links to your site a user saw on Google search results.

    search_console:impressions
  • CTR

    Click-through rate: the click count divided by the impression count.

    search_console:ctr
  • Average Position

    The average position of the topmost result from your site in different queries.

    search_console:position

Charts

5 metrics

  • Position and CTR Evolution

    The graph describes the evolution of position and CTR over the analysed period.

    search_console:ctr_and_position_over_time
  • Clicks and Impressions Evolution

    The graph describes the evolution of clicks and impressions over the analysed period.

    search_console:clicks_and_impressions_over_time
  • Clicks and Impressions by Hour

    The graph describes clicks and impressions hour by hour. Search Console provides hourly data only for the last 10 days, in Pacific Time, and the most recent hours may still be partial.

    search_console:clicks_and_impressions_by_hour
  • Clicks by Device

    Number of clicks, grouped by the device that the user was using.

    search_console:clicks_by_device
  • Impressions by Device

    Number of impressions, grouped by the device that the user was using.

    search_console:impressions_by_device

Tables

3 metrics

  • Featured Keywords

    Statistics of your site, grouped by the query and sorted by clicks. These are the queries that returned your site as a response to a search.

    search_console:query
  • Featured Pages

    Statistics of your site, grouped by page and sorted by clicks. The page is the destination of a link from Google's search result.

    search_console:pages
  • Featured Countries

    Statistics of your site, grouped by country.

    search_console:country

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.