How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Convert

Convert Locations API

Locations let you target your experiences in the ways that are important to your business.

Documentation Provider Profile APIs.io OpenAPI GitHub

Convert Locations API is one of 33 APIs that Convert publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Locations. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 9 operations across 9 paths, and defines 99 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 operations 9 paths 99 schemas 1 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 Locations 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.

Locations 9

Locations let you target your experiences in the ways that are important to your business.

POST
/accounts/{account_id}/projects/{project_id}/locations
List locations within a project
getLocationsList 2 params body → 200default
GET
/accounts/{account_id}/projects/{project_id}/locations/{location_id}
Get details for a specific location
getLocation 4 params → 200default
POST
/accounts/{account_id}/projects/{project_id}/locations/add
Create a new location
createLocation 2 params body → 201default
POST
/accounts/{account_id}/projects/{project_id}/locations/{location_id}/update
Update an existing location
updateLocation 3 params body → 200default
DELETE
/accounts/{account_id}/projects/{project_id}/locations/{location_id}/delete
Delete a location
deleteLocation 3 params → 200default
POST
/accounts/{account_id}/projects/{project_id}/locations/bulk-update
Update multiple locations at once
bulkLocationsUpdate 2 params body → 200default
POST
/accounts/{account_id}/projects/{project_id}/locations/bulk-delete
Delete multiple locations at once
bulkLocationsDelete 2 params body → 200default
GET
/accounts/{account_id}/projects/{project_id}/locations-presets
List predefined location templates (presets)
getLocationsPresets 2 params → 200default
POST
/accounts/{account_id}/projects/{project_id}/locations/{location_id}/clone
Clone an existing location
cloneLocation 4 params → 201default

Schemas 99

The contract defines 99 schemas that model the data the API accepts and returns. The most detailed are LocationBase (7 properties), LocationPreset (5 properties), Pagination (4 properties), ErrorData (3 properties). Each schema is shown below with its type and property counts.

BaseRuleWithBrowserNameValue
LocationsPresetsListResponseData
object
Response containing a list of predefined location templates (presets) available in the system.
1 property
BaseRuleWithSegmentBucketedValue
Pagination
object
4 properties
GenericTextKeyValueMatchRule
DayOfWeekMatchRule
WeatherConditionMatchRulesTypes
string
GenericBoolMatchRule
TextMatchingOptions
string
MinuteOfHourMatchRulesTypes
string
SortDirection
object
1 property
GenericTextKeyValueMatchRulesTypes
string
TextMatchRulesTypes
string
BaseRuleWithMinuteOfHourValue
GenericBoolKeyValueMatchRule
BaseRuleWithOsValue
BaseRuleWithStringValue
GenericNumericKeyValueMatchRule
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
LocationTriggerTypes
string
Specifies the mechanism that activates an experience when its location rules are met: - uponrun: (Default) The experience activates as soon as the Convert trac…
DayOfWeekMatchRulesTypes
string
VisitorTypeMatchRule
JsConditionMatchRulesTypes
string
BulkLocationsIds
array
A list of location unique numerical identifiers to be affected by a bulk operation.
LanguageMatchRulesTypes
string
BaseMatch
object
1 property
LocationIncludeFields
string
LocationDomTriggerEvents
string
The type of user interaction with a DOM element that will trigger the experience: - click: Activates when the element is clicked. - hover: Activates when the m…
RuleElement
GenericTextMatchRule
GenericNumericMatchRule
CookieMatchingOptions
string
Location
GetLocationsListRequestData
ErrorData
object
3 properties
LocationsPresetsList
array
A list of location preset objects.
CountryMatchRulesTypes
string
HourOfDayMatchRulesTypes
string
BaseRuleWithGoalTriggeredValue
LocationsListResponseData
object
Response containing a list of locations defined within a project, along with pagination details if applicable.
2 properties
WeatherConditionMatchRule
CookieMatchRulesTypes
string
BaseRuleWithVisitorTypeValue
LocationStatuses
string
The current status of a location: - active: The location is active and can be used for targeting experiences. - archived: The location is archived and no longe…
LocationPreset
object
5 properties
BaseRuleWithCountryCodeValue
BrowserNameMatchRule
Extra
object
1 property
BaseRuleWithJsCodeValue
LocationTriggerBase
object
1 property 1 required
GoalTriggeredMatchRulesTypes
string
PageNumber
object
1 property
SegmentBucketedMatchRule
SuccessData
object
2 properties
LocationRuleElement
VisitorTypeMatchRulesTypes
string
BrowserNameMatchRulesTypes
string
BaseRuleWithBooleanValue
LocationTriggerUponRun
SegmentBucketedMatchRulesTypes
string
MinuteOfHourMatchRule
GenericKey
object
1 property
BulkSuccessData
BaseRuleWithNumericValue
LocationTriggerDomElement
LocationTrigger
Defines how and when an experience associated with this location should be activated for a visitor who matches the location's rules. The type determines the ac…
OsMatchRulesTypes
string
NumericMatchingOptions
string
BaseRuleWithDayOfWeekValue
UpdateLocationRequestData
LocationTriggerManual
LocationsList
array
A list of location objects.
GenericBoolKeyValueMatchRulesTypes
string
LocationCreate
2 required
BaseRule
object
1 property 1 required
BulkUpdateLocationsRequestData
object
Request body for bulk updating the status of multiple locations.
2 properties 2 required
CreateLocationRequestData
ResultsPerPage
object
1 property
LocationRuleObject
object
Defines the logical structure for combining multiple rule conditions for a Location. It uses a nested OR - AND - ORWHEN structure, similar to Audience rules, b…
1 property
BaseRuleWithWeatherConditionValue
LocationBase
object
7 properties
NumericMatchRulesTypes
string
LanguageMatchRule
BulkDeleteLocationsRequestData
object
Request body for bulk deleting multiple locations. Contains a list of location IDs to be permanently removed.
1 property 1 required
BoolMatchRulesTypes
string
BulkEntityError
object
2 properties
BaseRuleWithLanguageCodeValue
GoalTriggeredMatchRule
JsConditionMatchRule
LocationsListFilteringOptions
OsMatchRule
BaseRuleWithHourOfDayValue
CountryMatchRule
ChoiceMatchingOptions
string
GenericNumericKeyValueMatchRulesTypes
string
HourOfDayMatchRule
CookieMatchRule
LocationTriggerCallback

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

convert-locations-api-openapi.yml Raw ↑

Other APIs Convert publishes across the network.

Convert Experiences REST API v2
AE Profile APIs.io
Convert Accounts API
AE Profile APIs.io
Convert AI content API
AE Profile APIs.io
Convert API Keys API
AE Profile APIs.io
Convert Audiences API
AE Profile APIs.io
Convert Bulk API
AE Profile APIs.io
Convert Cdn Images API
AE Profile APIs.io
Convert Collaborators API
AE Profile APIs.io
Convert Cookie Authentication API
AE Profile APIs.io
Convert Domains API
AE Profile APIs.io
Convert Experience Sections API
AE Profile APIs.io
Convert Experience Variations API
AE Profile APIs.io
#Locations
← Back to C APIs
API Details
ID
convert:convert-locations-api
Base URL
https://api.convert.com/api/v2
Docs
https://api.convert.com/doc/v2/
Provider
Convert
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

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.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=convert-locations-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/convert-locations-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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 Locations 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.