Create Incrementality Test
create_incrementality_testRecord an incrementality test in a project, including design, dates, KPI, result, and spend, to calibrate a model activity column.
Instructions
Record one incrementality test in a project, as analysed in its own tool: its design (geo, owned_media_ab or platform_lift block), dates, KPI, result with interval or sd, and incremental spend. Returns {id, version: 1, record, content_hash}. Set model_channel to the model activity column the test calibrates so it can be used with a model. Validation errors name the field (e.g. "the interval must contain lift_abs"). Not idempotent: calling twice records two tests. type time_holdout is not accepted here: planned time-holdout records are created only through save_incrementality_test_design (the backend refuses them elsewhere), and a status planned record of any type carries no result. Requires the create:models scope.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| record | Yes | One incrementality test as analysed in its own tool (Simba fits nothing here). type picks the design block: geo, owned_media_ab or platform_lift. Dates are YYYY-MM-DD; measured_through is the end of the carryover window (default end_date). result.lift_abs is the total lift in KPI units over the window; give its interval (two-sided, level e.g. 0.9) and/or sd. Null and negative lifts are valid. spend.incremental is the extra spend the test caused (signed). The time_holdout type and block appear on records the server builds from a test-design calculation (save_incrementality_test_design); they are read and listed here but not accepted on create or import, and a status planned record carries no result. | |
| project_id | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||