List goals within a project

post

https://api.convert.com/api/v2/accounts/{account_id}/projects/{project_id}/goals

Retrieves a list of all conversion goals defined for a specific project. Goals are used to measure the success of experiences (e.g., purchases, sign-ups, page views). Supports filtering by status, type, name, and pagination. The Knowledge Base article "Goals" describes various goal types like 'Visit a specific page', 'Revenue goal', 'Click on a link', etc.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account_id

integer

required

ID of the account that owns the retrieved/saved data

project_id

integer

required

ID of the project to which save/retrieved data is connected

Body Params

onlyCount

boolean

If set to true in a list request, the response will only contain the total count of matching items (extra.pagination.items_count) and will not include the actual item data. Useful for quickly getting totals without fetching full datasets.

results_per_page

integer | null

0 to 50

Defaults to 30

Specifies the maximum number of items to return in a single page of results. Used for pagination. Default is 30, maximum is 50.

sort_direction

string | null

enum

Defaults to desc

The direction for sorting the list results, based on the sort_by field.

asc: Ascending order (e.g., A-Z, 1-10, oldest to newest).
desc: Descending order (e.g., Z-A, 10-1, newest to oldest). Defaults to desc (newest/highest first) if not specified.

Allowed:

status

array of objects | null

List of goal statuses to be returned

status

is_default

boolean | null

A value that would be used to filter by default or not default goals. if not provided, all goals will be returned

string | null

A search string that would be used to search against Goal's name and description

tracking

string | null

enum

A value that would be used to filter by tracked or not tracked goals

Allowed:

usage

string | null

enum

A value that would be used to filter by using in at least one experiment

Allowed:

goal_type

array of objects | null

List of goal types to be returned

goal_type

experiences

array of integers | null

List of experiences to be returned

experiences

sort_by

string | null

enum

Defaults to id

A value to sort audiences by specific field

Defaults to id if not provided

Allowed:

page

integer

≥ 1

The page number for paginated results. For example, if results_per_page is 30, page: 2 will retrieve items 31-60. Defaults to 1 if not specified.

include

array of objects

Specifies the list of fields to be included in the response, which otherwise would not be sent.

include

only

array of integers | null

Only retrieve goals with the given ids. Including 'stats' reduces the maximum number of 'only' items to 50.

only

except

array of integers

length ≤ 200

Except goals with the given ids. Including 'stats' reduces the maximum number of 'except' items to 50.

except

Responses

200A list of conversion goals defined within a project. Each goal entry includes its ID, name, type, status, and potentially usage statistics if requested.

defaultIndicates an error occurred while processing the request. The code provides an HTTP status code, message offers a human-readable explanation or an array of validation errors, and fields (if present) specifies which input fields were problematic.