--- updatedAt: 2026-05-20T20:59:45.000Z agentTools: projectIndex: https://docs.developers.convert.com/llms.txt --- # Get report settings for an experience Retrieves the specific reporting settings for an experience. This includes configurations like confidence level, statistical methodology (Frequentist/Bayesian), MAB strategy, primary metric, and outlier detection rules. These settings govern how experiment results are calculated and displayed. The Knowledge Base article "Experiment Report" (Stats Settings section) covers these. # OpenAPI definition ```json { "openapi": "3.0.3", "info": { "title": "Convert Management API", "description": "Move your app forward with the Convert API. The Convert API allows\nyou to manage your Convert Experiences projects using code. The REST API is\nan interface for managing and extending functionality of Convert. For\nexample, instead of creating and maintaining projects using the Convert\nExperiences web dashboard you can create an experiment programmatically.\nAdditionally, if you prefer to run custom analysis on experiment results you\ncan leverage the API to pull data from Convert Experiences into your own\nworkflow. If you do not have a Convert account already, sign up for a free\ndeveloper account at https://www.convert.com/api/.\n\n*[Convert API V1](/doc/v1) is still available and documentation can be found [here](/doc/v1) but using it is highly discouraged\nas it will be phased out in the future*\n", "version": "2.0.0" }, "x-tagGroups": [ { "name": "Client Authentication", "tags": [ "API KEY Authentication", "Cookie Authentication", "OAuth Authorization" ] }, { "name": "Common Parameters", "tags": [ "Optional Fields", "Expandable Fields" ] }, { "name": "Requests", "tags": [ "User", "Accounts", "AI content", "Collaborators", "API Keys", "Notifications", "Projects", "SDK Keys", "Experiences", "Experience Variations", "Experience Sections", "Section Versions", "Version Changes", "Experiences Reports", "Experiences Heatmaps", "Goals", "Hypotheses", "Knowledge Bases", "Observations", "Locations", "Audiences", "Domains", "Cdn Images", "Files", "Tags", "Features", "Visitor Insights", "Visitors Data", "Visitor Data Placeholders", "OAuth", "Approval Requests" ] } ], "tags": [ { "name": "Experiences Reports", "description": "Specification for different reports data that can be retrieved for experiences" } ], "paths": { "/accounts/{account_id}/projects/{project_id}/experiences/{experience_id}/report_settings": { "get": { "operationId": "getExperienceReportSettings", "x-mutates": false, "summary": "Get report settings for an experience", "description": "Retrieves the specific reporting settings for an experience. This includes configurations like confidence level,\nstatistical methodology (Frequentist/Bayesian), MAB strategy, primary metric, and outlier detection rules.\nThese settings govern how experiment results are calculated and displayed.\nThe Knowledge Base article \"Experiment Report\" (Stats Settings section) covers these.\n", "tags": [ "Experiences Reports" ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "description": "ID of the account that owns the retrieved/saved data", "schema": { "type": "integer" } }, { "name": "project_id", "description": "ID of the project to which save/retrieved data is connected", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "experience_id", "in": "path", "required": true, "description": "ID of the experience", "schema": { "type": "integer" } }, { "name": "report_token", "in": "header", "required": false, "description": "Token to access the experience report in read-only mode.", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/ExperienceReportSettingsResponse" }, "default": { "$ref": "#/components/responses/ErrorResponse" } } } } }, "servers": [ { "url": "https://api.convert.com/api/v2", "description": "Live API server" }, { "url": "https://apidev.convert.com/api/v2", "description": "DEV API server" }, { "url": "http://apidev.convert.com:5000/api/v2", "description": "DEV mocked API server" } ], "components": { "securitySchemes": { "secretKey": { "type": "http", "scheme": "bearer", "description": "See **[API Key Authentication](/reference/api-key-authentication)** for more information.\n" }, "cookieAuthentication": { "type": "apiKey", "in": "cookie", "name": "sid", "description": "Cookie authentication is used against Convert's own IdentityProvider or third party identity providers and is described more in the \"[Cookie Authentication](/reference/cookie-authentication)\" section" }, "requestSigningAppId": { "type": "apiKey", "in": "header", "name": "Convert-Application-ID", "description": "HMAC request signing — the Application ID from your Convert account. See **[API Key Authentication](/reference/api-key-authentication)** for how to generate the full three-header set." }, "requestSigningExpires": { "type": "apiKey", "in": "header", "name": "Expires", "description": "HMAC request signing — UNIX timestamp after which the signature expires. See **[API Key Authentication](/reference/api-key-authentication)** for how to compute it." }, "requestSigningAuthorization": { "type": "apiKey", "in": "header", "name": "Authorization", "description": "HMAC request signing — format: `Convert-HMAC-SHA256 Signature=`. See **[API Key Authentication](/reference/api-key-authentication)** for the signing algorithm. The \"Try It\" playground cannot compute this for you; paste a pre-computed signature here or use the Bearer method instead." } }, "responses": { "ExperienceReportSettingsResponse": { "description": "The current reporting settings for an experience, such as `confidence_level`, `stats_methodology` (Frequentist/Bayesian), MAB strategy, `primary_metric`, and `outlier` detection rules.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExperienceReportSettingsData" } } } }, "ErrorResponse": { "description": "Indicates an error occurred while processing the request. The `code` provides an HTTP status code, `message` offers a human-readable explanation or an array of validation errors, and `fields` (if present) specifies which input fields were problematic.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorData" } } } } }, "schemas": { "SimpleAudienceSegment": { "type": "object", "properties": { "id": { "description": "The unique numerical identifier of the segment (audience).", "type": "integer" }, "name": { "description": "The user-defined, friendly name of the segment.", "type": "string" } } }, "ErrorData": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "context": { "type": "object", "description": "Additional context about the error." } } }, "ExperienceReportSettingsData": { "description": "Data structure containing the specific reporting settings configured for an experience.", "type": "object", "properties": { "data": { "type": "object", "properties": { "campaigns": { "description": "A list of unique marketing campaign names (from `utm_campaign`) that brought visitors to this experience. Includes visitor counts per campaign. Useful for segmenting results.", "type": "array", "readOnly": true, "items": { "type": "object", "properties": { "name": { "description": "The campaign name.", "type": "string" }, "visitors_count": { "description": "The number of visitors in this experience attributed to this campaign.", "type": "number" } } } }, "contents": { "description": "A list of unique ad-creative identifiers (from `utm_content`) that brought visitors to this experience. Includes visitor counts per ad creative. Useful for segmenting results.", "type": "array", "readOnly": true, "items": { "type": "object", "properties": { "name": { "description": "The ad-creative identifier.", "type": "string" }, "visitors_count": { "description": "The number of visitors in this experience attributed to this ad creative.", "type": "number" } } } }, "custom_segments": { "description": "A list of custom Convert Audience segments (of type 'segmentation') that visitors to this experience belonged to. Useful for post-test segmentation.", "type": "array", "readOnly": true, "items": { "$ref": "#/components/schemas/SimpleAudienceSegment" } } } } } } } }, "security": [ { "requestSigningAppId": [], "requestSigningExpires": [], "requestSigningAuthorization": [] }, { "secretKey": [] }, { "cookieAuthentication": [] } ] } ```