UTM Parameters

API + MCP

GET/v3/web-analytics/utm-params

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

Query parameters

limitinteger

The number of results to return.

order_bystring

Order by metric, as metric:desc or metric:asc. The following metrics are supported:

wherestring

Filter expression. Can mention dimensions and metrics.

tostring (date-time)

end datetime for the data query

fromstring (date-time)

start datetime for the data query

utm_paramstringRequired

Specify a UTM parameter to use as dimension.

Allowed values:utm_sourceutm_mediumutm_campaignutm_termutm_content

project_idintegerRequired

Project ID

outputstring

The output format.

Allowed values:jsoncsvxmlphp

Responses

statsarray<object>

utm_paramstring

UTM parameter value

visitorsinteger

Number of visitors

session_bounce_ratenumber (float)

Session bounce rate (percentage of sessions that triggered only one request)

avg_session_duration_secinteger

Average session duration (in seconds)

Parameters

limit

order_by

where

to

from

utm_paramRequired

project_idRequired

output

API key

Request

curl "https://api.ahrefs.com/v3/web-analytics/utm-params" \
  -H "Authorization: Bearer $AHREFS_API_KEY" \
  -H "Accept: application/json"

import requests

url = "https://api.ahrefs.com/v3/web-analytics/utm-params"
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/web-analytics/utm-params", {
  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/web-analytics/utm-params", 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

{
  "stats": [
    {
      "utm_param": "string",
      "visitors": 0,
      "session_bounce_rate": 0.0,
      "avg_session_duration_sec": 0
    }
  ]
}