UTM Parameters Chart
Requests to this endpoint are free and do not consume any API units.
Request
- Base URLhttps://api.ahrefs.com/v3
- URLhttps://api.ahrefs.com/v3/web-analytics/utm-params-chart
- AuthHTTP bearer
Query parameters
Specify which values to chart (as a comma separated list), if not provided then (top5-by-visitors) is used by default (which charts top 5 values by visitor count).
Filter expression. Can mention dimensions and metrics.
The following dimensions are supported:
source_channel: Source Channel
type: enum (search | llm | email | paid | search/paid | social | direct | newsletter | shopping/organic | shopping/paid | audio | social/paid | cross-network | mobile-push-notification | sms | affiliate | referral | display | internal)
source: Source
type: string
source_referer: Referer source
type: string
source_referer_domain: Referer domain
type: string
utm_source: UTM source
type: string
utm_medium: UTM medium
type: string
utm_campaign: UTM campaign
type: string
utm_term: UTM term
type: string
utm_content: UTM content
type: string
page: Page URL
type: url
page_domain: Page domain
type: string
page_title: Page title
type: string
entry_page: Entry page URL
type: url
exit_page: Exit page URL
type: url
continent: Continent
type: enum (AF | AS | EU | NA | OC | SA | AN | )
country: Country
type: string
city: City
type: string
browser_language: Browser language
type: string
browser: Browser
type: string
browser_version: Browser version
type: string
os: Operating system
type: string
os_version: Operating system version
type: string
device: Device type
type: string
screensize: Screen size
type: string
event_name: Event name
type: string
is_external_link_click: Is external link click
type: boolean
event_prop:EVENT_PROP: a custom event property can be specified by its name
type: string
The following metrics are supported:
pageviews: Number of pageview events
type: integer
visitors: Number of visitors
type: integer
visits: Number of visits
type: integer
session_bounce_rate: Session bounce rate (percentage of sessions that triggered only one request)
type: float
avg_session_length: Average session length (in seconds)
type: float
avg_session_duration_sec: Average session duration (in seconds)
type: integer
exit_rate: Exit rate (percentage of pageviews that were the last in the session)
type: float
exits: Number of exits
type: integer
entries: Number of entries
type: integer
avg_page_visit_duration_sec: Average page visit duration (in seconds)
type: integer
Filter is a JSON string that represents a boolean expression, it should follow the following structure:
<bool_filter> ::= { "and" : <bool_filter>+ }
| { "or" : <bool_filter>+ }
| { "not" : <bool_filter> }
| <expr>
<expr> ::= {
"field" : <dimension|metric>,
? "is": <condition>,
}
<condition> ::= [ "eq", <value> ]
| [ "neq", <value> ]
| [ "gt", <value> ]
| [ "gte", <value> ]
| [ "lt", <value> ]
| [ "lte", <value> ]
| [ "substring", <value> ]
| [ "isubstring", <value> ]
| [ "phrase_match", <value> ]
| [ "iphrase_match", <value> ]
| [ "prefix", <value> ]
| [ "suffix", <value> ]
Time granularity for chart data points.
end datetime for the data query
start datetime for the data query
Specify a UTM parameter to use as dimension.
Project ID
The output format.
Response
OK
Changes
No recorded changes to this operation across all 26 revisions of this API.