Last updated
Was this helpful?
Last updated
Was this helpful?
Name
Type
Dimension
DefaultMetric
DefaultDimension
Description
Date
Date
True
The date of the session formatted as YYYYMMDD.
Year
Integer
True
The year of the session. A four-digit year from 2005 to the current year.
Month
Integer
True
The month of the session. An integer from 01 to 12.
Week
Integer
True
The week of the session. A number from 01 to 53. Each week starts on Sunday.
Day
Integer
True
The day of the month. A number from 01 to 31.
Hour
Integer
True
An hour of the day ranging from 00-23 in the timezone configured for the account. This value is also corrected for daylight savings time.
SearchKeyword
String
True
True
Search terms used by users within your property.
SearchCategory
String
True
The categories used for the internal search if you have this enabled for your profile. For example, product categories, such as electronics, furniture, or clothing.
SearchStartPage
String
True
A page where the user initiated an internal search on your property.
SearchSessions
Integer
False
True
The total number of sessions that included an internal search.
PercentSessionsWithSearch
Double
False
True
The percentage of sessions with search.
SearchUniques
Integer
False
True
The total number of unique keywords from internal searches within a session.
SearchResultViews
Integer
False
True
The number of times a search result page was viewed after performing a search.
AvgSearchResultViews
Double
False
True
The average number of times people viewed a search results page after performing a search.
SearchExits
Integer
False
True
The number of exits on your site that occurred following a search result from your internal search feature.
SearchExitRate
Double
False
The percentage of searches that resulted in an immediate exit from your property.
SearchRefinements
Integer
False
The total number of times a refinement (transition) occurs between internal search keywords within a session.
PercentSearchRefinements
Double
False
True
The percentage of number of times a refinement (i.e., transition) occurs between internal search keywords within a session.
SearchDuration
Double
False
True
The session duration on your property where a use of your internal search feature occurred.
AvgSearchDuration
Double
False
The average amount of time people spent on your property after searching.
SearchDepth
Integer
False
The average number of subsequent page views made on your property after a use of your internal search feature.
AvgSearchDepth
Double
False
True
The average number of pages people viewed after performing a search on your property.
StartDate
String
Start date for fetching Analytics data. Either a date string or a relative date (e.g., today, yesterday, or #daysAgo).
EndDate
String
End date for fetching Analytics data. Either a date string or a relative date (e.g., today, yesterday, or #daysAgo).
Dimensions
String
A comma-separated list of dimensions to retrieve in addition to the columns defined in the schema. Set to empty string to retrieve no dimensions.
Metrics
String
A comma-separated list of metrics to retrieve in addition to the columns defined in the schema.
CohortTypes
String
Available only when using the V4 API. A comma-separated list of cohort types. The default value is FIRST_VISIT_DATE
CohortStartDates
Date
Available only when using the V4 API. A comma-separated list of cohort start dates.
CohortEndDates
Date
Available only when using the V4 API. A comma-separated list of cohort end dates.
SamplesReadCounts
String
Comma separated list of samples read counts when the response data is sampled.
SamplingSpaceSizes
String
Comma separated list of samples space sizes counts when the response data is sampled.
Name
Type
Description
Segments
String
Segments the data returned for your request. Either a SegmentId or a custom segment.
Profile
String
The Profile ID or website URL to retrieve data from.