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

Convert Observations API

The Observations API from Convert — 7 operation(s) for observations.

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

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

This API exposes 7 operations across 7 paths, and defines 81 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.

7 operations 7 paths 81 schemas 1 DELETE1 GET5 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 Observations 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 7

Across 7 paths, the API surfaces 7 operations — 1 DELETE, 1 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Observations 7
POST
/accounts/{account_id}/projects/{project_id}/observations
List observations within a project
getObservationsList 2 params body → 200default
GET
/accounts/{account_id}/projects/{project_id}/observations/{observation_id}
Get details for a specific observation
getObservation 4 params → 200default
POST
/accounts/{account_id}/projects/{project_id}/observations/add
Create a new observation
createObservation 3 params body → 201default
POST
/accounts/{account_id}/projects/{project_id}/observations/{observation_id}/update
Update an existing observation
updateObservation 4 params body → 200default
DELETE
/accounts/{account_id}/projects/{project_id}/observations/{observation_id}/delete
Delete an observation
deleteObservation 3 params → 200default
POST
/accounts/{account_id}/projects/{project_id}/observations/bulk-update
Update multiple observations at once
bulkObservationsUpdate 2 params body → 200default
POST
/accounts/{account_id}/projects/{project_id}/observations/bulk-delete
Delete multiple observations at once
bulkObservationsDelete 2 params body → 200default

Schemas 81

The contract defines 81 schemas that model the data the API accepts and returns. The most detailed are ExperienceReportingSettings (18 properties), BaseProject (12 properties), BaseObservation (9 properties), Pagination (4 properties). Each schema is shown below with its type and property counts.

SE_ProcTypes
string
The statistical methodology used for analyzing experiment results and determining winners. - frequentist: Traditional hypothesis testing approach using p-value…
TagExpandableRequest
Represents a tag when associating it with another entity (like an experience or goal) during a create or update operation. Can be either the existing integer I…
ObservationsListFilteringOptions
ObservationStatuses
string
The current status of an observation in its lifecycle: - active: The observation is current, under consideration, or being actively discussed. This is the defa…
Pagination
object
4 properties
IntegrationGA3
object
2 properties
GetObservationsListRequestData
CreateUpdateObservation
TrackingScriptReleaseLatest
SimpleLocation
object
2 properties
TagExpandable
Represents a tag, either as its unique ID or as the full tag object (ID, name, description) if expanded.
ObservationsListResponseData
object
Response containing a list of observations for a project, along with pagination details if applicable.
2 properties
BaseProject
object
12 properties
CreateObservationRequestData
SortDirection
object
1 property
Project
Represents a Convert project, which is a container for organizing a set of related optimization activities (experiences), their goals, target audiences, associ…
GA_SettingsBase
object
1 property
NumericOutlier
CustomDomainOwnershipVerificationItem
object
3 properties
ObservationImage
OnlyCount
object
1 property
ProjectStatuses
string
The overall status of a project: - active: The project is active, and experiences within it can run and track data. - inactive: The project is inactive (archiv…
NumericOutlierPercentile
VisualEditorUserAgents
string
Predefined User-Agent strings that the Visual Editor can emulate for responsive design and device-specific testing.
GenerateDebugTokenData
object
2 properties
UpdateObservationRequestData
Percentiles
number
Standard percentile values used for outlier detection thresholds. For example, a min of 5 and max of 95 means orders in the bottom 5% and top 5% of values are…
SE_ProcSettingsBayesian
ErrorData
object
3 properties
MetricTypes
string
The primary types of performance metrics calculated by the reporting engine for each goal. - conversionrate: The percentage of visitors who completed the goal…
UTC_Offset
integer
The time offset from Coordinated Universal Time (UTC) in seconds. For example, UTC-5 (EST) would be -18000. UTC+2 would be 7200. Used for interpreting or displ…
SimpleAudienceExpandable
TrackingScriptReleaseManual
SimpleLocationExpandable
TagToCreate
1 required
GA_Settings
SE_MabSettings
object
Configuration for Multi-Armed Bandit (MAB) traffic allocation. If null, MAB is disabled and manual traffic allocation is used. MAB dynamically allocates more t…
2 properties
NumericOutlierNone
Extra
object
1 property
SimpleGoal
object
2 properties
PageNumber
object
1 property
SuccessData
object
2 properties
TrackingScriptReleaseAutomaticApplyOn
object
Configuration for scheduled tracking script updates, specifying the day of the week and time for automatic application of new versions.
2 properties 2 required
IntegrationGA4
ProjectGASettingsBase
SimpleGoalExpandable
AccessRoleNames
string
The predefined names for user access roles within the Convert system. Each role grants a specific set of permissions. - owner: Highest level, full control over…
BulkDeleteObservationsRequestData
object
Request body for bulk deleting multiple observations. Contains a list of observation IDs to be permanently removed.
1 property 1 required
BulkSuccessData
ObservationFile
TrackingScriptAvailableVersions
array
A list of available versions for the Convert tracking script, each with a version tag, changelog, release date, and potentially the date it was or will be appl…
Observation
IntegrationGA4Base
object
2 properties
VisitorInsightsBase
object
3 properties
Domain
object
A website domain data.
3 properties
ProjectIntegrationGA4
NumericOutlierBase
object
1 property 1 required
ObservationsList
array
A list of observation objects.
BulkObservationIds
array
A list of observation unique numerical identifiers to be affected by a bulk operation.
ResultsPerPage
object
1 property
SimpleAudience
object
2 properties
NumericOutlierTypes
string
The method used for detecting and handling order outliers in revenue or product count tracking: - none: No outlier detection is applied. - minmax: Orders with…
UploadedFileData
object
File Object
3 properties
ExperienceReportingSettings
object
Comprehensive settings governing how an experience's results are reported and analyzed.
18 properties
BulkEntityError
object
2 properties
TrackingScriptRelease
BaseObservation
object
9 properties
CreateObservation
TrackingScriptReleaseBase
object
Base settings for managing how new versions of the Convert tracking script are applied to the project.
1 property
BulkUpdateObservationsRequestData
object
Request body for bulk updating the status of multiple observations.
2 properties 2 required
ProjectIntegrationGA3
NumericOutlierMinMax
ObservationImageData
object
(Deprecated) Represents an image attached to an observation.
2 properties
Tag
object
Represents a tag (keyword or label) that can be associated with various Convert entities like experiences, goals, audiences, hypotheses, and observations. Tags…
3 properties
SE_ProcSettingsBase
object
1 property
TrackingScriptReleaseScheduled
SE_ProcSettingsFrequentist
ObservationsExpandFields
string
DNSRecordTypes
string
The type of the DNS record.
ProjectExpandable
SE_ProcSettings
Overall settings for the statistical engine processing results for this experience.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

convert-observations-api-openapi.yml Raw ↑

Other APIs Convert publishes across the network.

Convert Experiences REST API v2
Convert Accounts API
Convert AI content API
Convert API Keys API
Convert Audiences API
Convert Bulk API
Convert Cdn Images API
Convert Collaborators API
Convert Cookie Authentication API
Convert Domains API
Convert Experience Sections API
Convert Experience Variations API
Where this information came from

This is an independent, third-party profile of Convert Observations 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.