List

Lists goals to which the user has access

5 variables
47 variables

Lists goals to which the user has access

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • View and manage your Google Analytics data
  • Edit Google Analytics management entities
  • View your Google Analytics data

Input

This building block consumes 5 input parameters

  = Parameter name
  = Format

accountId STRING Required

Account ID to retrieve goals for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to

webPropertyId STRING Required

Web property ID to retrieve goals for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to

profileId STRING Required

View (Profile) ID to retrieve goals for. Can either be a specific view (profile) ID or '~all', which refers to all the views (profiles) that user has access to

max-results INTEGER

The maximum number of goals to include in this response

start-index INTEGER

An index of the first goal to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter

Output

This building block provides 47 output parameters

  = Parameter name
  = Format

items[] OBJECT

JSON template for Analytics goal resource

items[].accountId STRING

Account ID to which this goal belongs

items[].active BOOLEAN

Determines whether this goal is active

items[].created DATE_TIME

Time this goal was created

items[].eventDetails OBJECT

Details for the goal of the type EVENT

items[].eventDetails.eventConditions[] OBJECT

items[].eventDetails.eventConditions[].comparisonType STRING

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

items[].eventDetails.eventConditions[].comparisonValue INTEGER

Value used for this comparison

items[].eventDetails.eventConditions[].expression STRING

Expression used for this match

items[].eventDetails.eventConditions[].matchType STRING

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

items[].eventDetails.eventConditions[].type STRING

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

items[].eventDetails.useEventValue BOOLEAN

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

items[].id STRING

Goal ID

items[].internalWebPropertyId STRING

Internal ID for the web property to which this goal belongs

items[].kind STRING

Resource type for an Analytics goal

items[].name STRING

Goal name

items[].parentLink OBJECT

Parent link for a goal. Points to the view (profile) to which this goal belongs

items[].parentLink.href STRING

Link to the view (profile) to which this goal belongs

items[].parentLink.type STRING

Value is "analytics#profile"

items[].profileId STRING

View (Profile) ID to which this goal belongs

items[].selfLink STRING

Link for this goal

items[].type STRING

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

items[].updated DATE_TIME

Time this goal was last modified

items[].urlDestinationDetails OBJECT

Details for the goal of the type URL_DESTINATION

items[].urlDestinationDetails.caseSensitive BOOLEAN

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

items[].urlDestinationDetails.firstStepRequired BOOLEAN

Determines if the first step in this goal is required

items[].urlDestinationDetails.matchType STRING

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

items[].urlDestinationDetails.steps[] OBJECT

items[].urlDestinationDetails.steps[].name STRING

Step name

items[].urlDestinationDetails.steps[].number INTEGER

Step number

items[].urlDestinationDetails.steps[].url STRING

URL for this step

items[].urlDestinationDetails.url STRING

URL for this goal

items[].value FLOAT

Goal value

items[].visitNumPagesDetails OBJECT

Details for the goal of the type VISIT_NUM_PAGES

items[].visitNumPagesDetails.comparisonType STRING

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

items[].visitNumPagesDetails.comparisonValue INTEGER

Value used for this comparison

items[].visitTimeOnSiteDetails OBJECT

Details for the goal of the type VISIT_TIME_ON_SITE

items[].visitTimeOnSiteDetails.comparisonType STRING

Type of comparison. Possible values are LESS_THAN or GREATER_THAN

items[].visitTimeOnSiteDetails.comparisonValue INTEGER

Value used for this comparison

items[].webPropertyId STRING

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

itemsPerPage INTEGER

The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter

kind STRING

Collection type

nextLink STRING

Link to next page for this goal collection

previousLink STRING

Link to previous page for this goal collection

startIndex INTEGER

The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter

totalResults INTEGER

The total number of results for the query, regardless of the number of resources in the result

username STRING

Email ID of the authenticated user