Skip to main content

analyticsDimension

Returns one ranked dimension under dimension; use analytics for multiple dimensions. Supply a preset or window within available history. Defaults to descending page views for pages and visitors otherwise; reuse nextCursor to continue, and a null cursor means no rows were returned. Requires web analytics view access.

analyticsDimension(
  dimension: AnalyticsDimension!
  sourceId: Int!
  sourceType: AnalyticsSource!
  searchTerm: String
  startAt: Int
  endAt: Int
  presetDate: String
  limit: Int
  orderBy: OrderColumn
  orderDir: OrderDir
  cursor: AnalyticsCursorDataArg
  numSegments: Int
): AnalyticsSingle

Arguments​

analyticsDimension.dimension ● AnalyticsDimension! non-null enum​

Breakdown to return; page and entry-page series always measure page views.

analyticsDimension.sourceId ● Int! non-null scalar​

Site ID from sites for SITE, or property ID from gaProperties for GA_PROPERTY.

analyticsDimension.sourceType ● AnalyticsSource! non-null enum​

SITE selects Crazy Egg data; GA_PROPERTY selects imported Google Analytics data.

analyticsDimension.searchTerm ● String scalar​

Optional case-insensitive substring filter. Countries and languages match display names and referrers match name or domain after the row limit; other dimensions match raw values before it.

analyticsDimension.startAt ● Int scalar​

Unix seconds for the window start. Supply with endAt when no preset is given; site dates use UTC and GA dates use the property's time zone.

analyticsDimension.endAt ● Int scalar​

Unix seconds; rows include this calendar date, in UTC for SITE or the property's time zone for GA. Supply with startAt unless presetDate is used.

analyticsDimension.presetDate ● String scalar​

Case-insensitive preset that overrides startAt/endAt: today, yesterday, recent (today plus six prior days), last 7 days, last 30 days (both end yesterday), this month, or last month; others error.

analyticsDimension.limit ● Int scalar​

Maximum fetched rows, default 250. Use a nonnegative count, or -1 for no row limit.

analyticsDimension.orderBy ● OrderColumn enum​

Defaults to PAGE_VIEWS for pages and VISITORS otherwise. Pages accept NAME, PAGE_VIEWS, or AVG_TIME_ON_PAGE; other columns fall back to PAGE_VIEWS.

analyticsDimension.orderDir ● OrderDir enum​

Ranking direction, default DESC. Metric ties use ascending names, with domain and path ordering for pages.

analyticsDimension.cursor ● AnalyticsCursorDataArg input​

Boundary from analyticsDimension.nextCursor; omit initially. Only pages, entry pages, referrers, and UTM dimensions paginate; other dimensions ignore cursors.

analyticsDimension.numSegments ● Int scalar​

Top time-series count, default 5, with remaining values grouped as others. Used by analyticsOverTime; ranked-row queries do not use it.

Type​

AnalyticsSingle object​

Single-dimension analytics payload used when one ranked dimension is requested independently from the full dashboard query.