RGA (version 0.4.2)

get_goal: Goals

Description

Gets a goal to which the user has access.

Usage

get_goal(accountId, webPropertyId, profileId, goalId, token)

Arguments

accountId

character. Account ID to retrieve the goal for.

webPropertyId

character. Web property ID to retrieve the goal for.

profileId

character. View (Profile) ID to retrieve the goal for.

goalId

character. Goal ID to retrieve the goal for.

token

Token2.0 class object with a valid authorization data.

Value

A Goals resource describes a goal for one of a user's profiles.

id

Goal ID.

kind

Resource type for an Analytics goal.

accountId

Account ID to which this goal belongs.

webPropertyId

Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY.

internalWebPropertyId

Internal ID for the web property to which this goal belongs.

profileId

View (Profile) ID to which this goal belongs.

name

Goal name.

value

Goal value.

active

Determines whether this goal is active.

type

Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, and EVENT.

created

Time this goal was created.

updated

Time this goal was last modified.

urlDestinationDetails

Details for the goal of the type URL_DESTINATION.

visitTimeOnSiteDetails

Details for the goal of the type VISIT_TIME_ON_SITE.

visitNumPagesDetails

Details for the goal of the type VISIT_NUM_PAGES.

eventDetails

Details for the goal of the type EVENT.

urlDestinationDetails.url

URL for this goal.

urlDestinationDetails.caseSensitive

Determines if the goal URL must exactly match the capitalization of visited URLs.

urlDestinationDetails.matchType

Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX.

urlDestinationDetails.firstStepRequired

Determines if the first step in this goal is required.

urlDestinationDetails.steps.number

Step number.

urlDestinationDetails.steps.name

Step name.

urlDestinationDetails.steps.url

URL for this step.

visitTimeOnSiteDetails.comparisonType

Type of comparison. Possible values are LESS_THAN or GREATER_THAN.

visitTimeOnSiteDetails.comparisonValue

Value used for this comparison.

visitNumPagesDetails.comparisonType

Type of comparison. Possible values are LESS_THAN, GREATER_THAN, or EQUAL.

visitNumPagesDetails.comparisonValue

Value used for this comparison.

eventDetails.useEventValue

Determines if the event value should be used as the value for this goal.

eventDetails.eventConditions.type

Type of this event condition. Possible values are CATEGORY, ACTION, LABEL, or VALUE.

eventDetails.eventConditions.matchType

Type of the match to be performed. Possible values are REGEXP, BEGINS_WITH, or EXACT.

eventDetails.eventConditions.expression

Expression used for this match.

eventDetails.eventConditions.comparisonType

Type of comparison. Possible values are LESS_THAN, GREATER_THAN or EQUAL.

eventDetails.eventConditions.comparisonValue

Value used for this comparison.

References

Management API - Goals Overview

See Also

Other Management API: get_custom_dimension, get_custom_metric, get_experiment, get_filter, get_profile, get_unsampled_report, get_upload, get_webproperty, list_accounts, list_custom_data_sources, list_custom_dimensions, list_custom_metrics, list_experiments, list_filters, list_goals, list_profiles, list_segments, list_unsampled_reports, list_uploads, list_webproperties