Skip to main content
GET
Get GA engagement metrics
Get engagement rate with period-over-period comparison. See Analytics (GA4) for the shared filters parameter.

Authorizations

Authorization
string
header
required

Your SnowSEO API key (sk_...).

Query Parameters

teamId
string
required

Team ID

days
integer
default:30

Days back from today on the team's calendar, converted to startDate/endDate. Ignored when startDate or endDate is set. Defaults to 30.

Required range: x >= 1
startDate
string

Start date (YYYY-MM-DD)

endDate
string

End date (YYYY-MM-DD)

country
string

Country filter

filters

A JSON object, sent as a string, mapping a dimension to the values to keep, e.g. {"page":["/blog/my-post"],"deviceCategory":["mobile"]}. Dimensions: page, referrer, channel, campaign, deviceCategory, browser, os. Several values for one dimension match any of them; several dimensions must all match. Use values the provider's filter_values tool returns for that dimension; page values are paths without query string or trailing slash. Filter by country with country. Invalid JSON, an unknown dimension or a non-list value returns 400 (code INVALID_FILTERS) naming the supported dimensions.

Response

200 - application/json

Default Response

engagementRate
number
engagementRateChange
object | null