Audiences let you segment your users in the ways that are important to your business. You can segment by event (e.g., session_start or level_up) and by user property (e.g., Browser/OS, Geo, Language), and combine events, parameters, and properties to include practically any subset of users. Read more information about Audiences.
Convert Audiences API is one of 33 APIs that Convert publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Audiences. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes
9 operations
across 9 paths,
and defines 100 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 paths100 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 Audiences 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.
Audiences 9
Audiences let you segment your users in the ways that are important to your business. You can segment by event (e.g., sessionstart or levelup) and by user property (e.g., Browser/…
The contract defines 100 schemas that model the data the API accepts and returns. The most detailed are AudienceBase (7 properties), AudiencePreset (5 properties), Pagination (4 properties), ErrorData (3 properties). Each schema is shown below with its type and property counts.
BaseRuleWithBrowserNameValue
AudienceTypesWithUrl
string
Defines the behavior for an audience that includes URL-based conditions in its rules. - segmentation: Once a visitor matches the audience criteria (which can i…
BaseRuleWithSegmentBucketedValue
Pagination
object
4 properties
GenericTextKeyValueMatchRule
DayOfWeekMatchRule
WeatherConditionMatchRulesTypes
string
GenericBoolMatchRule
GetAudiencesListRequestData
TextMatchingOptions
string
MinuteOfHourMatchRulesTypes
string
SortDirection
object
1 property
GenericTextKeyValueMatchRulesTypes
string
AudiencePreset
object
5 properties
BaseRuleWithMinuteOfHourValue
TextMatchRulesTypes
string
GenericBoolKeyValueMatchRule
BaseRuleWithOsValue
AudiencesPresetsListResponseData
object
Response containing a list of predefined audience templates (presets) available in the system.
1 property
BaseRuleWithStringValue
GenericNumericKeyValueMatchRule
OnlyCount
object
1 property
AudiencesListResponseData
object
Response containing a list of audiences defined within a project, along with pagination details if applicable.
2 properties
RuleObjectAudience
object
This one describes a logical rule that is being used inside the app for triggering goals, matching audiences etc
1 property
VisitorTypeMatchRule
DayOfWeekMatchRulesTypes
string
JsConditionMatchRulesTypes
string
BulkUpdateAudienceRequestData
object
Request body for bulk updating the status of multiple audiences.
2 properties2 required
LanguageMatchRulesTypes
string
BaseMatch
object
1 property
AudiencesList
array
A list of audience objects.
GenericNumericMatchRule
GenericTextMatchRule
RuleElementNoUrl
CookieMatchingOptions
string
ErrorData
object
3 properties
VisitorDataExistsMatchRulesTypes
string
RuleObjectNoUrl
object
Similar to RuleObject, but the individual RuleElementNoUrl conditions within ORWHEN arrays cannot include URL-based matching types. Used for 'permanent' or 'tr…
1 property
CountryMatchRulesTypes
string
HourOfDayMatchRulesTypes
string
BaseRuleWithGoalTriggeredValue
WeatherConditionMatchRule
CookieMatchRulesTypes
string
BaseRuleWithVisitorTypeValue
Audience
BaseRuleWithCountryCodeValue
BrowserNameMatchRule
AudienceWithUrlMatching
AudienceWithUrlMatchingCreate
3 required
AudienceTypesNoUrl
string
Defines the behavior and persistence of an audience that does not use URL-based conditions in its rules. - permanent: Once a visitor matches the audience crite…
AudienceCreate
Extra
object
1 property
BaseRuleWithJsCodeValue
GoalTriggeredMatchRulesTypes
string
PageNumber
object
1 property
SegmentBucketedMatchRule
UpdateAudienceRequestData
SuccessData
object
2 properties
VisitorTypeMatchRulesTypes
string
BrowserNameMatchRulesTypes
string
AudiencesListFilteringOptions
AudienceWithoutUrlMatchingCreate
3 required
BaseRuleWithBooleanValue
SegmentBucketedMatchRulesTypes
string
MinuteOfHourMatchRule
GenericKey
object
1 property
BulkSuccessData
BaseRuleWithNumericValue
OsMatchRulesTypes
string
AudienceWithoutUrlMatching
NumericMatchingOptions
string
BaseRuleWithDayOfWeekValue
GenericBoolKeyValueMatchRulesTypes
string
BaseRule
object
1 property1 required
AudienceTypes
string
AudienceIncludeFields
string
ResultsPerPage
object
1 property
BaseRuleWithWeatherConditionValue
LanguageMatchRule
NumericMatchRulesTypes
string
VisitorDataExistsMatchRule
BoolMatchRulesTypes
string
AudienceStatuses
string
The status of an audience: - active: The audience is currently active and can be used for targeting experiences. - archived: The audience is no longer active a…
AudiencesPresetsList
array
A list of audience preset objects.
BulkEntityError
object
2 properties
BaseRuleWithLanguageCodeValue
BulkAudiencesIds
array
A list of audience unique numerical identifiers to be affected by a bulk operation.
GoalTriggeredMatchRule
RuleElementAudience
JsConditionMatchRule
BulkDeleteAudienceRequestData
object
Request body for bulk deleting multiple audiences. Contains a list of audience IDs to be permanently removed.
1 property1 required
OsMatchRule
BaseRuleWithHourOfDayValue
CountryMatchRule
ChoiceMatchingOptions
string
AudienceBase
object
7 properties
GenericNumericKeyValueMatchRulesTypes
string
HourOfDayMatchRule
CookieMatchRule
CreateAudienceRequestData
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 Audiences 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.
