List business goals (agent-oriented read)

get

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

A read-optimized listing of business goals, separate from GET /initiatives/{initiativeId}. Returned directly from InitiativeAgentDataService::getInitiatives(). Conversions are always included inline for every business goal; conversion trigger detail (conversionEvents) is only populated on the single-goal endpoint, never here. Assets (automations, campaigns, forms, sms) are included inline only when includeAssets=true -- otherwise every assets list comes back empty.

Query Params

limit

integer

Number of business goals per page, 1 to 100.

page

integer

Page to return, starting at 1.

isArchived

integer

enum

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

Accepted by the underlying query DTO shared with GET /initiatives, but currently has no effect on this endpoint: InitiativeAgentDataController::getInitiatives() never reads GetInitiativesQuery::getShouldIncludeAssociationCounts(), and InitiativeAgentDataService::getInitiatives() has no parameter for it. The response never carries association counts regardless of this value.

includeConversionLabels

string

Defaults to false

Accepted by the underlying query DTO shared with GET /initiatives, but currently has no effect on this endpoint: InitiativeAgentDataController::getInitiatives() never reads GetInitiativesQuery::getShouldIncludeConversionLabels(), and InitiativeAgentDataService::getInitiatives() has no parameter for it. Conversions are already returned inline on every business goal regardless of this value -- this flag does not gate them here (it does on GET /initiatives).

includeAssets

string

enum

Defaults to false

When true, each business goal's assets object is populated with its linked automations, campaigns, forms and SMS broadcasts. When false (default), assets is still present on every business goal but every list inside it is empty.

Allowed:

useOverviewConfig

string

Defaults to 0

When true, results are restricted to and ordered by the account's configured goals overview sort order (falling back to favorited goals), instead of the normal paginated listing.

orders

object

A single column-to-direction mapping, e.g. orders[created_timestamp]=DESC. Only the first key is honored if more than one is supplied. Column must be one of folder, updated_timestamp, created_timestamp; direction is case-insensitive and normalized to ASC/DESC.

filters

object

A field-to-value map applied as additional equality filters, e.g. filters[source]=1. goal_type, goal_value and conversion_target_status resolve against the goal's linked conversion folder; every other key filters the business goal's own record directly. Keys are restricted to the set below and an unlisted key is rejected with 422. Empty string and null values are ignored.

Response

Language

Credentials

Header

URL

Loading…

Response

Choose an example:

application/json

200200