Remove specific data from an experience report

post

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

Allows for targeted deletion of report data for an experience based on date range and event type (view_experience, conversion, transaction). For conversion and transaction events, specific goals can be targeted. If simulate is true, returns a count of records that would be deleted without actual deletion. Otherwise, performs permanent deletion. The Knowledge Base article "Remove Report Data Feature" details 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 removing specific data from an experience's report. Requires:

start_time, end_time: Defines the period for data deletion.
events: An array specifying the types of events to delete (e.g., 'view_experience', 'conversion', 'transaction'). For 'conversion' and 'transaction', specific goals can be targeted. For 'transaction', revenue_start_value and revenue_end_value can filter by revenue amount.
simulate: If true (default), returns a count of records that would be deleted. If false, performs permanent deletion. Also supports utc_offset and segments.

Parameters needed to drill down the report.

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

required

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

required

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.

events

array

length ≥ 1

List of the events that would be targeted by the delete operation. If not provided, all the events would be targeted.

events

simulate

boolean

Defaults to true

When simulate - true is passed, it will only return back an object with the numbers of how many records will be deleted, instead of deleting any records

Responses

200If simulate=true was used in the request, this returns a count of data records per event type that would have been deleted. If simulate=false, confirms successful deletion (often via a general SuccessResponse).

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.