Export an experience report (CSV/PDF)

post

https://api.convert.com/api/v2/accounts/{account_id}/projects/{project_id}/experiences/{experience_id}/export_report

Generates an export of an experience's performance report in either CSV (aggregated or daily) or PDF format. Returns a downloadable link for the generated file. Useful for offline analysis or sharing with stakeholders. The Knowledge Base article "Experiment Report" (Export & Download section) describes this.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account_id

integer

required

ID of the account that owns the retrieved/saved data

project_id

integer

required

ID of the project to which save/retrieved data is connected

experience_id

integer

required

ID of the experience

Body Params

Parameters for exporting an experience report. Requires:

report_type: 'csv_aggregated' (summary data per variation) or 'csv_daily' (day-by-day data).
data_type: (For csv_daily only) 'cumulative' or 'non_cumulative'.
goals: (Optional) List of goal IDs to include. Also supports start_time, end_time, utc_offset, segments, and stats_engine_processing settings to match the online report.

Base Parameters needed to drill down the reports.

report_type

string

enum

Defaults to csv_aggregated

Type of the exported report:

csv_aggregated - export in CSV format the number of visitors and metrics values aggregated per variation for the whole reported period
csv_aggregated_tabular - export in CSV format same as above but with headings tabular for export
csv_daily - export in CSV format the number of visitors and metrics values per day, per variation for the whole reported period
csv_daily_tabular - export in CSV format same as above but with headings tabular for export

Allowed:

data_type

string | null

enum

Defaults to non_cumulative

Type of data the exported report (csv_daily only)

Allowed:

goals

array of integers | null

A list of goal Id's for which to return the reporting data.

If no ID is provided, the list of goals attached to the experience is being used.

Max 10 goals at one time available for csv_daily type.

goals

utc_offset

integer

-43200 to 50400

Defaults to 0

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 displaying date/time information according to a specific timezone.

start_time

number | null

Unix timestamp (seconds since epoch) for the beginning of the reporting period. If null, data from the experience start is typically used. Should be interpreted with utc_offset.

end_time

number | null

Unix timestamp (seconds since epoch) for the end of thereporting period. If null, data up to the current time is typically used. Should be interpreted with utc_offset.

segments

object

A collection of filters used to segment experience report data based on various visitor attributes and traffic sources. Applying these filters allows for deeper analysis of how different user groups interact with experience variations. Knowledge Base: "Using Basic and Advanced Post segmentation".

stats_engine_processing

Overall settings for the statistical engine processing results for this experience.

Responses

200Contains a download_url for the generated experience report (CSV or PDF) and an expire_at timestamp for the URL.

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