Goals

Goals

Get goals of the account environment

get

Return the list of the goals of the account environment

Authorizations
AuthorizationstringRequired

Prefix the token with 'Bearer ' to indicate it is a bearer token

Path parameters
account_idstringRequired

The ID of the account

account_environment_idstringRequired

The ID of the environment

Query parameters
_pageintegerOptional

Index of the page

Example: 0
_max_per_pageintegerOptional

Number of items per page

Example: 10
Responses
200

Success

application/json
current_item_countinteger · intOptional

Returns the number of items in the current page

current_pageinteger · intOptional

Returns the number of the current page

Default: 0
total_countinteger · intOptional

Returns the number of total items

items_per_pageinteger · intOptional

Returns the number of items per page

Default: 10
last_pageinteger · intOptional

Returns the index of the page

get
/accounts/{account_id}/account_environments/{account_environment_id}/goals

Create a goal

post

Create a goal

Authorizations
AuthorizationstringRequired

Prefix the token with 'Bearer ' to indicate it is a bearer token

Path parameters
account_idstringRequired

The ID of the account

account_environment_idstringRequired

The ID of the environment

Body
typestring · enumOptional

Type of the goal

Possible values:
idstringRead-onlyOptional

ID of the goal

labelstringRequired

Label of the goal

operatorstring · enumOptional

Operator of the goal (for pageview, screenview types)

Possible values:
valuestringOptional

Value of the goal (for pageview, screenview types)

Responses
post
/accounts/{account_id}/account_environments/{account_environment_id}/goals

Get one goal

get

Return one goal by its id

Authorizations
AuthorizationstringRequired

Prefix the token with 'Bearer ' to indicate it is a bearer token

Path parameters
account_idstringRequired

The ID of the account

account_environment_idstringRequired

The ID of the environment

goal_idstringRequired

The ID of the goal

Responses
200

Success

application/json
typestring · enumOptional

Type of the goal

Possible values:
idstringRead-onlyOptional

ID of the goal

labelstringRequired

Label of the goal

operatorstring · enumOptional

Operator of the goal (for pageview, screenview types)

Possible values:
valuestringOptional

Value of the goal (for pageview, screenview types)

get
/accounts/{account_id}/account_environments/{account_environment_id}/goals/{goal_id}

Delete a goal

delete

Delete a goal by its id.

Authorizations
AuthorizationstringRequired

Prefix the token with 'Bearer ' to indicate it is a bearer token

Path parameters
account_idstringRequired

The ID of the account

account_environment_idstringRequired

The ID of the environment

goal_idstringRequired

The ID of the goal

Responses
delete
/accounts/{account_id}/account_environments/{account_environment_id}/goals/{goal_id}

No content

Update a goal

patch

Update goal informations - You can set only the properies you want to update in the request body.

Authorizations
AuthorizationstringRequired

Prefix the token with 'Bearer ' to indicate it is a bearer token

Path parameters
account_idstringRequired

The ID of the account

account_environment_idstringRequired

The ID of the environment

goal_idstringRequired

The ID of the goal

Body
idstringRead-onlyOptional

ID of the goal

labelstringRequired

Label of the goal

operatorstring · enumOptional

Operator of the goal (for pageview, screenview types)

Possible values:
valuestringOptional

Value of the goal (for pageview, screenview types)

Responses
200

Updated

application/json
typestring · enumOptional

Type of the goal

Possible values:
idstringRead-onlyOptional

ID of the goal

labelstringRequired

Label of the goal

operatorstring · enumOptional

Operator of the goal (for pageview, screenview types)

Possible values:
valuestringOptional

Value of the goal (for pageview, screenview types)

patch
/accounts/{account_id}/account_environments/{account_environment_id}/goals/{goal_id}

Last updated

Was this helpful?