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

GET

management

Lists goals 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

{
    "items": [
        {
            "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"
        }
    ],
    "itemsPerPage": 0,
    "kind": "analytics#goals",
    "nextLink": "string",
    "previousLink": "string",
    "startIndex": 0,
    "totalResults": 0,
    "username": "string"
}

Request

Path Params

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.

Query Params

max-results

integer

optional

The maximum number of goals to include in this response.

start-index

integer

optional

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

Responses

🟢200Successful response

application/json

Body

A goal collection lists Analytics goals to which the user has access. Each view (profile) can have a set of goals. Each resource in the Goal collection corresponds to a single Analytics goal.

items

array[object (Goal) {18}]

optional

A list of goals.

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.

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.

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.

value

number <float>

optional

Goal value.

visitNumPagesDetails

object

optional

Details for the goal of the type VISIT_NUM_PAGES.

visitTimeOnSiteDetails

object

optional

Details for the goal of the type VISIT_TIME_ON_SITE.

webPropertyId

string

optional

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

itemsPerPage

integer <int32>

optional

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

optional

Collection type.

Default:

analytics#goals

nextLink

string

optional

Link to next page for this goal collection.

previousLink

string

optional

Link to previous page for this goal collection.

startIndex

integer <int32>

optional

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

totalResults

integer <int32>

optional

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

username

string

optional

Email ID of the authenticated user

/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}

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