Goals measure how well your site fulfills your target objectives. A goal represents a completed activity, called a conversion, that contributes to the success of your business. Examples of goals include making a purchase (for an ecommerce site), completing a game level (for a mobile gaming site), or submitting a contact information form (for a marketing or lead generation site). Read more information about Goals.
Convert Goals API is one of 33 APIs that Convert publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Goals. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes
9 operations
across 9 paths,
and defines 113 schemas.
It is described by OpenAPI 3.2.0, at version 2.0.0.
Requests are made against 3 base URLs: https://api.convert.com/api/v2, https://apidev.convert.com/api/v2, http://apidev.convert.com:5000/api/v2.
9 operations9 paths113 schemas1 DELETE2 GET6 POST
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://api.convert.com/api/v2
Authentication
API Key, HTTP Bearer, API Key
Resource Areas
1
Authentication & Security 3
Convert Goals API declares
3 security schemes
for authenticating requests.
An API key is passed in the header as Authorization (requestSigning).
It accepts HTTP bearer tokens (secretKey).
An API key is passed in the cookie as sid (cookieAuthentication).
requestSigning — See [API Key Authentication](tag/API-KEY-Authentication) for more information.
secretKey — See [API Key Authentication](tag/API-KEY-Authentication) for more information.
cookieAuthentication — Cookie authentication is used against Convert's own IdentityProvider or third party identity providers and is described more in the "[Cookie Authentication](ta…
Paths & Operations 9
Across 9 paths, the API surfaces 9 operations — 1 DELETE, 2 GET, 6 POST. Each is listed below with its method, path, parameters, and response codes.
Goals 9
Goals measure how well your site fulfills your target objectives. A goal represents a completed activity, called a conversion, that contributes to the success of your business. Ex…
The contract defines 113 schemas that model the data the API accepts and returns. The most detailed are GoalBase (9 properties), Pagination (4 properties), ErrorData (3 properties), BulkUpdateGoalRequestData (2 properties). Each schema is shown below with its type and property counts.
BaseRuleWithBrowserNameValue
BaseRuleWithSegmentBucketedValue
Pagination
object
4 properties
GenericTextKeyValueMatchRule
DayOfWeekMatchRule
WeatherConditionMatchRulesTypes
string
GenericBoolMatchRule
CreateSubmitsFormGoal
3 required
TextMatchingOptions
string
MinuteOfHourMatchRulesTypes
string
SortDirection
object
1 property
GenericTextKeyValueMatchRulesTypes
string
BaseRuleWithMinuteOfHourValue
TextMatchRulesTypes
string
GoalStatuses
string
The current status of a goal: - active: The goal is active and will track conversions for experiences it's attached to. - archived: The goal is archived and wi…
GenericBoolKeyValueMatchRule
CreateAdvancedGoal
3 required
BaseRuleWithOsValue
ScrollPercentageGoalSettings
object
1 property1 required
BaseRuleWithStringValue
GenericNumericKeyValueMatchRule
BulkUpdateGoalRequestData
object
Request body for bulk updating the status of multiple goals.
2 properties2 required
OnlyCount
object
1 property
RuleObject
object
Defines the logical structure for combining multiple rule conditions. It uses a nested OR - AND - ORWHEN structure. - The top-level OR array means if any of it…
1 property
VisitorTypeMatchRule
DayOfWeekMatchRulesTypes
string
JsConditionMatchRulesTypes
string
LanguageMatchRulesTypes
string
CreateGaGoal
2 required
BaseMatch
object
1 property
RuleElement
GenericNumericMatchRule
GenericTextMatchRule
CookieMatchingOptions
string
ErrorData
object
3 properties
RevenueGoalSettings
object
1 property1 required
CountryMatchRulesTypes
string
HourOfDayMatchRulesTypes
string
GoalsListResponseData
object
Response containing a list of conversion goals defined within a project, along with pagination details if applicable.
2 properties
BaseRuleWithGoalTriggeredValue
BulkDeleteGoalRequestData
object
Request body for bulk deleting multiple goals. Contains a list of goal IDs to be permanently removed.
1 property1 required
CreateClicksElementGoal
3 required
WeatherConditionMatchRule
CookieMatchRulesTypes
string
BaseRuleWithVisitorTypeValue
CreateGoal
GoalsList
array
A list of goal objects.
ClicksLinkGoal
AdvancedGoal
BaseRuleWithCountryCodeValue
BrowserNameMatchRule
DomInteractionGoalSettings
object
1 property1 required
GoalOptionalFields
string
CreateNoSettingsGoal
2 required
SubmitsFormGoal
Extra
object
1 property
BaseRuleWithJsCodeValue
GoalTriggeredMatchRulesTypes
string
PageNumber
object
1 property
SegmentBucketedMatchRule
CreateRevenueGoal
3 required
CreateDomInteractionGoal
3 required
SuccessData
object
2 properties
CreateScrollPercentageGoal
3 required
VisitorTypeMatchRulesTypes
string
BrowserNameMatchRulesTypes
string
BaseRuleWithBooleanValue
GaGoalSettings
object
1 property
ScrollPercentageGoal
SegmentBucketedMatchRulesTypes
string
ClicksLinkGoalSettings
object
1 property1 required
GoalsListFilteringOptions
MinuteOfHourMatchRule
GoalTypes
string
The type of user action or event that this goal tracks as a conversion. - advanced: A goal defined by a complex set of custom rules using the Advanced Goal Edi…
GenericKey
object
1 property
RevenueGoal
BulkSuccessData
BaseRuleWithNumericValue
CreateGoalRequestData
BulkGoalsIds
array
The list of goals id to delete
OsMatchRulesTypes
string
NumericMatchingOptions
string
BaseRuleWithDayOfWeekValue
ClicksElementGoalSettings
object
2 properties1 required
GenericBoolKeyValueMatchRulesTypes
string
BaseRule
object
1 property1 required
ResultsPerPage
object
1 property
BaseRuleWithWeatherConditionValue
LanguageMatchRule
NumericMatchRulesTypes
string
GoalStats
object
2 properties
ClicksElementGoal
BoolMatchRulesTypes
string
GoalBase
object
Base properties common to all types of conversion goals.
9 properties
BulkEntityError
object
2 properties
GaGoal
BaseRuleWithLanguageCodeValue
GoalTriggeredMatchRule
JsConditionMatchRule
OsMatchRule
Goal
BaseRuleWithHourOfDayValue
DomInteractionGoal
CountryMatchRule
ChoiceMatchingOptions
string
NoSettingsGoal
GenericNumericKeyValueMatchRulesTypes
string
SubmitsFormGoalSettings
object
1 property1 required
HourOfDayMatchRule
CookieMatchRule
GetGoalsRequestData
CreateClicksLinkGoal
3 required
UpdateGoalRequestData
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Convert Goals API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.
