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 Experiences Reports API

Specification for different reports data that can be retrieved for experiences

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

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

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

8 operations 8 paths 66 schemas 1 GET7 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 Experiences Reports 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 8

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

Experiences Reports 8

Specification for different reports data that can be retrieved for experiences

GET
/accounts/{account_id}/projects/{project_id}/experiences/{experience_id}/report_settings
Get report settings for an experience
getExperienceReportSettings 4 params → 200default
POST
/accounts/{account_id}/projects/{project_id}/experiences/{experience_id}/aggregated_report
Get aggregated performance report for an experience
getExperienceAggregatedReport 4 params body → 200default
POST
/accounts/{account_id}/projects/{project_id}/experiences/{experience_id}/daily_report
Get daily performance report for an experience
getExperienceDailyReport 4 params body → 200default
POST
/accounts/{account_id}/projects/{project_id}/experiences/{experience_id}/daily_traffic_allocation
Get daily traffic allocation report for an MAB experience
getExperienceDailyTrafficAllocation 4 params body → 200default
POST
/accounts/{account_id}/projects/{project_id}/experiences/{experience_id}/reset_report
Reset report data for an experience
resetExperienceReport 3 params → 200default
POST
/accounts/{account_id}/projects/{project_id}/experiences/{experience_id}/export_report
Export an experience report (CSV/PDF)
exportExperienceReport 3 params body → 200default
POST
/accounts/{account_id}/projects/{project_id}/experiences/{experience_id}/export_raw_data
Export raw tracking data for an experience
exportExperienceRawData 3 params body → 200default
POST
/accounts/{account_id}/projects/{project_id}/experiences/{experience_id}/remove_report_data
Remove specific data from an experience report
removeExperienceReportData 3 params body → 200default

Schemas 66

The contract defines 66 schemas that model the data the API accepts and returns. The most detailed are ReportingSegmentsFilters (7 properties), ExperienceVariationBase (6 properties), RemoveExperienceReportEventTypeTransaction (4 properties), ExperienceAggregatedGoalReportBase (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…
RemoveExperienceReportResponseDataItem
object
2 properties
ExperienceDailyReportExtraDataItem
object
2 properties
ExperienceAggregatedGoalBayesian
ExperienceVariationBaseExtended
ExperienceAggregatedReportBase
object
2 properties
ExperienceDailyTrafficAllocationReport
object
Provides a day-by-day breakdown of traffic allocation percentages for each variation in an experience, typically used for MAB experiments.
2 properties
ExperienceAggregatedGoalReportFrequentist
ReportingSegmentsCustomSegment
integer
The numerical ID of a custom Convert Audience (of type 'segmentation') that the visitor is a member of. Allows report segmentation based on predefined custom s…
GetExperienceAggregatedReportRequestData
ExperienceReportExportResponseData
object
1 property
ExperienceAggregatedMetricReportFrequentist
DailyReportMetrics
string
The specific performance metric to be displayed in a daily report.
ExportExperienceRawDataEvents
string
Specifies the type of raw tracking events to be included in an export or targeted for removal. - viewexperience: Events logged when a visitor is first bucketed…
ExperienceAggregatedMetricReportBayesian
ExperienceVariationStatuses
string
ExperienceAggregatedMetricBayesian
RemoveExperienceReportEventTypeViewExperience
object
Specifies deletion of 'viewexperience' events.
1 property 1 required
ReportingSegmentsFilters
object
A collection of filters used to segment experience report data based on various visitor attributes and traffic sources. Applying these filters allows for deepe…
7 properties
DailyReportTypes
string
Determines how daily data is aggregated in time-series reports.
BaseMetricNoStatistics
object
3 properties
ReportingSegmentsSource
string
The traffic source that brought the visitor to the site (e.g., 'google', 'facebook.com', 'direct', 'newsletter'). Derived from utmsource URL parameters or the…
ReportingSegmentsBrowser
string
The web browser used by the visitor. Used for segmenting reports to understand how experiences perform across different browsers. Knowledge Base: "Using Basic…
ExperienceAggregatedReportFrequentist
ExperienceDailyTrafficAllocationResponseData
object
1 property
SE_ProcSettingsBayesian
ErrorData
object
3 properties
RemoveExperienceReportRequestData
2 required
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…
GetExperienceDailyTrafficAllocationRequestData
ExportExperienceReportRequestData
ReportingSegmentsCampaign
string
The campaign name associated with the visitor's session, typically derived from utmcampaign URL parameters. Allows report segmentation by marketing campaign. K…
ExperienceDailyReportResponseData
object
1 property
TimeRangeRequestData
object
Parameters for defining a specific time range for report data retrieval.
3 properties
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
BaseMetric
GetExperienceDailyReportRequestData
ExperienceAggregatedReportResponseData
object
1 property
ExportExperienceRawDataRequestData
SuccessData
object
2 properties
ReportingSegmentsCountry
string
The two-letter ISO 3166-1 alpha-2 country code of the visitor, determined by IP geolocation. Used for segmenting reports by country to analyze geographical per…
ExperienceAggregatedMetricFrequentist
ExperienceAggregatedReport
ExperienceAggregatedMetricNoStatistics
ExperienceAggregatedReportBayesian
ReportingSegmentsVisitorType
string
Classifies the visitor as either 'new' or 'returning' based on their site visit history (tracked by Convert cookies). - new: First-time visitor to the site (or…
RemoveExperienceReportEventTypeConversion
object
Specifies deletion of 'conversion' events, optionally filtered by specific goals.
2 properties 1 required
ConcurrencyKey
string
A server-generated hash that represents the object's state at the time of retrieval. When included in an update request, the operation will only succeed if the…
ExperienceReportRawDataEvents
ExportExperienceRawDataResponseData
object
1 property
ExperienceReportSettingsData
object
Data structure containing the specific reporting settings configured for an experience.
1 property
ExperienceAggregatedGoalReportBase
object
4 properties
SimpleAudienceSegment
object
2 properties
BaseReportRequestData
RemoveExperienceReportEventTypeTransaction
object
Specifies deletion of 'transaction' (revenue) events, optionally filtered by specific goals and revenue amounts.
4 properties 1 required
RemoveExperienceReportResponseData
object
1 property
ReportingSegmentsDeviceCategories
string
The category of device used by the visitor. Enables report segmentation by device type. - iPhone, otherphones, allphones: Mobile phone categories. - desktop: D…
ExperienceDailyReport
object
2 properties
ReportExtraStatsTypes
string
Types of aggregated daily statistics that can be included in the 'extra' section of a daily report.
ExperienceReportVariationsData
array
An array containing basic identifying information for each variation in the experience (ID, name, baseline status, traffic distribution).
ExperienceVariationBase
object
6 properties
SE_ProcSettingsBase
object
1 property
SE_ProcSettingsFrequentist
StatsDataPoint
object
Represents a single data point in a time series, typically for a specific day.
2 properties
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-experiences-reports-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 Experiences Reports 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.