Performance by device

API + MCP

GET/v3/gsc/performance-by-device

Requests to this endpoint are free and do not consume any API units.

Query parameters

project_idinteger

Project ID. Required when portfolio_id is not provided.

portfolio_idinteger

Portfolio ID. When provided, aggregates data across all GSC-connected projects in the portfolio.

date_fromstring (date)Required

The start date of the historical period in YYYY-MM-DD format.

date_tostring (date)

The end date of the historical period in YYYY-MM-DD format.

search_typestring

The type of search results to return (web, image, video, news).

Allowed values:webimagevideonews

Default:web

countrystring

A two-letter country code (ISO 3166-1 alpha-2).

Allowed values:adaeafagaialamaoarasatauawazba…

wherestring

Supported fields:

outputstring

The output format.

Allowed values:jsoncsvxmlphp

Responses

metricsarray<object>

clicksnumber (float)

ctrnumber (float)

devicestring

impressionsnumber (float)

positionnumber (float)

Average position (decimal, e.g. 4.7)

Parameters

project_id

portfolio_id

date_fromRequired

date_to

search_type

country

where

output

API keyRequired

Request

curl "https://api.ahrefs.com/v3/gsc/performance-by-device" \
  -H "Authorization: Bearer $AHREFS_API_KEY" \
  -H "Accept: application/json"

import requests

url = "https://api.ahrefs.com/v3/gsc/performance-by-device"
headers = {
    "Authorization": "Bearer $AHREFS_API_KEY",
    "Accept": "application/json"
}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch("https://api.ahrefs.com/v3/gsc/performance-by-device", {
  method: "GET",
  headers: {
    "Authorization": "Bearer $AHREFS_API_KEY",
    "Accept": "application/json"
  }
});

const data = await response.json();
console.log(data);

req, _ := http.NewRequest("GET", "https://api.ahrefs.com/v3/gsc/performance-by-device", nil)
req.Header.Set("Authorization", "Bearer $AHREFS_API_KEY")
req.Header.Set("Accept", "application/json")

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

data, _ := io.ReadAll(resp.Body)
fmt.Println(string(data))

Response

200 OK

{
  "metrics": [
    {
      "clicks": 0.0,
      "ctr": 0.0,
      "device": "string",
      "impressions": 0.0,
      "position": 0.0
    }
  ]
}