List all business goals

get

https://{youraccountname}.api-us1.com/api/3/initiatives

Returns the account's business goals, active by default or archived with isArchived=1, newest first unless orders says otherwise. Results are paginated with limit and page. meta carries the account's total number of active goals and of archived goals. Optional flags add each goal's association counts and linked conversions. Query parameter names are accepted in camelCase or snake_case (isArchived or is_archived).

Query Params

limit

integer

1 to 100

Defaults to 10

Number of business goals per page, 1 to 100.

page

integer

Defaults to 1

Page to return, starting at 1.

isArchived

integer

enum

Defaults to 0

1 to list archived business goals, 0 to list active ones.

Allowed:

string

Only business goals whose name contains this text.

includeAssociationCounts

string

Defaults to false

When true, each business goal carries the number of automations, campaigns, forms and SMS broadcasts in its folder (labeled with it in the API) (automationLabelCount, campaignLabelCount, formLabelCount, smsLabelCount). Accepts true or 1 for yes, false or 0 for no.

includeConversionLabels

string

Defaults to false

When true, each business goal carries its linked conversions in conversionLabels (conversion folders in the UI). Accepts true or 1 for yes, false or 0 for no.

includeAssets

string

enum

Defaults to false

Accepted for compatibility with GET /businessGoals/data, but has no effect on this endpoint.

Allowed:

useOverviewConfig

string

Defaults to false

When true, results are limited to and ordered by the account's Overview goals configuration, falling back to favorited goals, instead of the normal listing. Accepts true or 1 for yes, false or 0 for no.

orders

object

A single column-to-direction mapping, such as orders[created_timestamp]=DESC. Only the first key is used. The column must be one of folder, updated_timestamp or created_timestamp; the direction is ASC or DESC, case-insensitive. Any other column or direction is rejected with 422.

filters

object

Equality filters keyed by field, such as filters[source]=1. goal_type, goal_value and conversion_target_status match against the goal's linked conversion; every other key matches the business goal itself. Empty and null values are ignored. A key outside the list is rejected with 422.

Responses

422

A query parameter is invalid: limit is not 1 to 100, isArchived is not 0 or 1, or orders or filters use an unsupported key.

Language

Credentials

Header

URL

Loading…

Response

Choose an example:

application/json

200The requested page of business goals and the account totals.