Get report integrity check for an experience

post

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

Compares a recent window to an equal-length prior baseline window and flags per-stream drops where a stream
was receiving data in the baseline and stopped receiving data in the recent window.

Two windows of identical length are derived from the since parameter:

Recent: [now − since, now]
Baseline: [now − 2·since, now − since]

Each window boundary can also be set explicitly via the optional recent_start, recent_end, baseline_start
and baseline_end parameters (Unix timestamps in seconds). An explicit boundary takes priority over the
since-derived value; any boundary that is not supplied is still calculated from since. These may be combined
with since — for example, supplying only recent_start and baseline_start overrides those two starts while
both ends continue to be derived from since.

The check covers two types of streams:

Bucketing: overall experiment traffic (visitors bucketed into the experience).
Goal: per-goal conversion events for each goal attached to the experience (or the subset specified via goals).

A stream is flagged when its baseline count meets the min_baseline threshold (i.e. it was genuinely receiving data)
but its recent count is zero, indicating that data flow has stopped.

If the experience was not live for the full duration of both windows, live_across_window is false and
all streams are returned with flagged: false and reason: "experiment_not_live".

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 controlling the integrity check. All fields are optional — sensible defaults are applied when omitted:

since: window length; defaults to "7d". The recent window is [now − since, now]; the baseline is [now − 2·since, now − since].
min_baseline: minimum count for a stream to be considered active in the baseline; defaults to 3.
recent_start, recent_end, baseline_start, baseline_end: explicit window boundaries as Unix timestamps (seconds). Each is optional and, when supplied, takes priority over the corresponding since-derived boundary. Boundaries left unset are still calculated from since. They may be combined with since — e.g. supplying only recent_start and baseline_start overrides those two starts while both ends are derived from since.
goals: specific goal IDs to check; if omitted or null, all goals attached to the experience are used.
utc_offset: UTC offset in seconds for day-boundary calculations; defaults to 0 (UTC).

Parameters controlling the integrity check window and thresholds.
All fields are optional — omitting them applies the documented defaults.

since

string

^\d+[dh]$

Defaults to 7d

Length of the window to inspect, expressed as a number followed by d (days) or h (hours).
For example, "7d" means seven days; "24h" means twenty-four hours.
The recent window is [now − since, now]; the baseline window is [now − 2·since, now − since].

min_baseline

integer

≥ 0

Defaults to 3

Minimum count required in the baseline window for a stream to be considered as having been active.
A stream whose baseline count is below this threshold is never flagged regardless of its recent count.

recent_start

integer | null

≥ 0

Explicit start of the recent window, as a Unix timestamp (seconds since epoch).
Optional. When supplied it takes priority over the since-derived value.
Any boundary left unset is still calculated from since.

recent_end

integer | null

≥ 0

Explicit end of the recent window, as a Unix timestamp (seconds since epoch).
Optional. When supplied it takes priority over the since-derived value.
Any boundary left unset is still calculated from since.

baseline_start

integer | null

≥ 0

Explicit start of the baseline window, as a Unix timestamp (seconds since epoch).
Optional. When supplied it takes priority over the since-derived value.
Any boundary left unset is still calculated from since.

baseline_end

integer | null

≥ 0

Explicit end of the baseline window, as a Unix timestamp (seconds since epoch).
Optional. When supplied it takes priority over the since-derived value.
Any boundary left unset is still calculated from since.

goals

array of integers | null

A list of goal IDs for which to return integrity data.
If omitted or null, all goals attached to the experience are used.

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.

Headers

report_token

string

Token to access the experience report in read-only mode.

Responses

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Report integrity analysis for the requested experience. Contains a data object with the integrity result, including per-stream (bucketing + per-goal) flags indicating whether a stream that was active in the baseline window dropped to zero in the recent window.

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.