List Goals

List all goals for a site.

List Goals

Returns all goals configured for the given site.

Endpoint

GET /api/v1/organizations/:orgId/sites/:siteId/goals

Response fields

Each goal object contains:

FieldTypeDescription
idstringGoal ID
site_idstringSite ID
namestringGoal display name
typestringpageview or custom_event
patternstringPage path or event name to match
match_typestringexact, contains, or regex
valuenumberOptional monetary value per conversion
currencystringOptional currency code (e.g. USD)

Goal Stats

To get conversion stats for all goals in a period:

GET /api/v1/organizations/:orgId/sites/:siteId/goals/stats

Returns an array of stats per goal:

FieldTypeDescription
goal_idstringGoal ID
namestringGoal name
typestringGoal type
conversionsnumberTotal conversions
unique_conversionsnumberUnique visitor conversions
revenuenumberTotal revenue from conversions
conversion_ratenumberPercentage of visitors who converted