/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}

GET

management

Gets a goal to which the user has access.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://analytics.googleapis.com/analytics/v3/management/accounts//webproperties//profiles//goals/'

Response Example

{
  "accountId": "string",
  "active": true,
  "created": "2019-08-24T14:15:22Z",
  "eventDetails": {
    "eventConditions": [
      {
        "comparisonType": "string",
        "comparisonValue": "string",
        "expression": "string",
        "matchType": "string",
        "type": "string"
      }
    ],
    "useEventValue": true
  },
  "id": "string",
  "internalWebPropertyId": "string",
  "kind": "analytics#goal",
  "name": "string",
  "parentLink": {
    "href": "string",
    "type": "analytics#profile"
  },
  "profileId": "string",
  "selfLink": "string",
  "type": "string",
  "updated": "2019-08-24T14:15:22Z",
  "urlDestinationDetails": {
    "caseSensitive": true,
    "firstStepRequired": true,
    "matchType": "string",
    "steps": [
      {
        "name": "string",
        "number": 0,
        "url": "string"
      }
    ],
    "url": "string"
  },
  "value": 0,
  "visitNumPagesDetails": {
    "comparisonType": "string",
    "comparisonValue": "string"
  },
  "visitTimeOnSiteDetails": {
    "comparisonType": "string",
    "comparisonValue": "string"
  },
  "webPropertyId": "string"
}

Request

Path Params

accountId

string

required

Account ID to retrieve the goal for.

webPropertyId

string

required

Web property ID to retrieve the goal for.

profileId

string

required

View (Profile) ID to retrieve the goal for.

goalId

string

required

Goal ID to retrieve the goal for.

Responses

🟢200Successful response

application/json

Body

JSON template for Analytics goal resource.

accountId

string

optional

Account ID to which this goal belongs.

active

boolean

optional

Determines whether this goal is active.

created

string <date-time>

optional

Time this goal was created.

eventDetails

object

optional

Details for the goal of the type EVENT.

eventConditions

array [object {5}]

optional

List of event conditions.

useEventValue

boolean

optional

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

string

optional

Goal ID.

internalWebPropertyId

string

optional

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

kind

string

optional

Resource type for an Analytics goal.

Default:

analytics#goal

name

string

optional

Goal name.

parentLink

object

optional

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

href

string

optional

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

type

string

optional

Value is "analytics#profile".

Default:

analytics#profile

profileId

string

optional

View (Profile) ID to which this goal belongs.

selfLink

string

optional

Link for this goal.

type

string

optional

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

updated

string <date-time>

optional

Time this goal was last modified.

urlDestinationDetails

object

optional

Details for the goal of the type URL_DESTINATION.

caseSensitive

boolean

optional

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

firstStepRequired

boolean

optional

Determines if the first step in this goal is required.

matchType

string

optional

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

steps

array [object {3}]

optional

List of steps configured for this goal funnel.

url

string

optional

URL for this goal.

value

number <float>

optional

Goal value.

visitNumPagesDetails

object

optional

Details for the goal of the type VISIT_NUM_PAGES.

comparisonType

string

optional

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

comparisonValue

string <int64>

optional

Value used for this comparison.

visitTimeOnSiteDetails

object

optional

Details for the goal of the type VISIT_TIME_ON_SITE.

comparisonType

string

optional

Type of comparison. Possible values are LESS_THAN or GREATER_THAN.

comparisonValue

string <int64>

optional

Value used for this comparison.

webPropertyId

string

optional

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

Modified at 2023-08-15 05:39:07

/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals

/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}