REST API reference

Download OpenAPI. Every endpoint below uses the existing runtime URL. Provider connection, import execution, AI generation, administration, and session endpoints are outside this public API contract.

Activities

List activities — GET /activities

Attachments

List attachments — GET /attachments
Create attachment — POST /attachments
Delete attachment — DELETE /attachments/{attachment}
Get attachment — GET /attachments/{attachment}
Update attachment — PATCH /attachments/{attachment}
Update attachment — PUT /attachments/{attachment}
List attachments — GET /{type}/{id}/attachments

Audiences

List audiences — GET /audiences
Create audience — POST /audiences
Delete audience — DELETE /audiences/{audience}
Get audience — GET /audiences/{audience}
Update audience — PATCH /audiences/{audience}
Update audience — PUT /audiences/{audience}

Comments

List comments — GET /comments
Create comment — POST /comments
Delete comment — DELETE /comments/{comment}
Update comment — PATCH /comments/{comment}
Update comment — PUT /comments/{comment}

Daily Briefs

Get daily brief — GET /daily-briefs/today

Experiment States

List experiment states — GET /experiment-states
Create experiment state — POST /experiment-states
Reorder experiment states — PUT /experiment-states/order
Delete experiment state — DELETE /experiment-states/{experiment_state}
Get experiment state — GET /experiment-states/{experiment_state}
Update experiment state — PATCH /experiment-states/{experiment_state}
Update experiment state — PUT /experiment-states/{experiment_state}

Experiments

List experiments — GET /experiments
Create experiment — POST /experiments
Apply a bulk action to experiments — POST /experiments/bulk
Delete experiment — DELETE /experiments/{experiment}
Get experiment — GET /experiments/{experiment}
Update experiment — PATCH /experiments/{experiment}
Update experiment — PUT /experiments/{experiment}
List experiment approvals — GET /experiments/{experiment}/approvals
Record experiment approvals — POST /experiments/{experiment}/approvals
Distribute traffic for experiment — POST /experiments/{experiment}/distribute-traffic
Get the result report for experiment — GET /experiments/{experiment}/summary
Get result time series for experiment — GET /experiments/{experiment}/timeseries

Forms

List forms — GET /forms
Create form — POST /forms
Apply a bulk action to forms — POST /forms/bulk
Duplicate form — POST /forms/duplicate
Delete form — DELETE /forms/{form}
Get form — GET /forms/{form}
Update form — PATCH /forms/{form}
Update form — PUT /forms/{form}
Get form — GET /forms/{form}/response-summary
Reset survey responses — DELETE /forms/{form}/responses
List forms — GET /forms/{form}/responses
Export responses for form — GET /forms/{form}/responses/export

Idea States

List idea states — GET /idea-states
Create idea state — POST /idea-states
Reorder idea states — PUT /idea-states/order
Delete idea state — DELETE /idea-states/{idea_state}
Get idea state — GET /idea-states/{idea_state}
Update idea state — PATCH /idea-states/{idea_state}
Update idea state — PUT /idea-states/{idea_state}

Ideas

List ideas — GET /ideas
Create idea — POST /ideas
Apply a bulk action to ideas — POST /ideas/bulk
Delete idea — DELETE /ideas/{idea}
Get idea — GET /ideas/{idea}
Update idea — PATCH /ideas/{idea}
Update idea — PUT /ideas/{idea}

Insight Labels

List insight labels — GET /insight-labels
Create insight label — POST /insight-labels
Delete insight label — DELETE /insight-labels/{insight_label}
Get insight label — GET /insight-labels/{insight_label}
Update insight label — PATCH /insight-labels/{insight_label}
Update insight label — PUT /insight-labels/{insight_label}

Insights

List insights — GET /insights
Create insight — POST /insights
Apply a bulk action to insights — POST /insights/bulk
Delete insight — DELETE /insights/{insight}
Get insight — GET /insights/{insight}
Update insight — PATCH /insights/{insight}
Update insight — PUT /insights/{insight}

Learnings

List learnings — GET /learnings
Create learning — POST /learnings
Apply a bulk action to learnings — POST /learnings/bulk
Delete learning — DELETE /learnings/{learning}
Get learning — GET /learnings/{learning}
Update learning — PATCH /learnings/{learning}
Update learning — PUT /learnings/{learning}

Metrics

List metrics — GET /metrics
Create metric — POST /metrics
Delete metric — DELETE /metrics/{metric}
Get metric — GET /metrics/{metric}
Update metric — PATCH /metrics/{metric}
Update metric — PUT /metrics/{metric}

Numbering Schemes

List numbering schemes — GET /numbering-schemes
Create numbering scheme — POST /numbering-schemes
Preview numbering scheme — POST /numbering-schemes/preview
Update numbering scheme — PATCH /numbering-schemes/{numberingScheme}
Update numbering scheme — PUT /numbering-schemes/{numberingScheme}
Backfill identifiers using numbering scheme — POST /numbering-schemes/{numberingScheme}/backfill

Observations

List observations — GET /observations
Create observation — POST /observations
Apply a bulk action to observations — POST /observations/bulk
Delete observation — DELETE /observations/{observation}
Get observation — GET /observations/{observation}
Update observation — PATCH /observations/{observation}
Update observation — PUT /observations/{observation}
Accept observation — POST /observations/{observation}/accept
Dismiss observation — POST /observations/{observation}/dismiss
Permanently delete an archived observation — DELETE /observations/{observation}/force
Restore an archived observation — POST /observations/{observation}/restore
Restore a dismissed observation — POST /observations/{observation}/restore-dismissal

Prio Models

List prio models — GET /prio-models
Create prio model — POST /prio-models
Validate the formula for prio model — POST /prio-models/validate-formula
Recalculate priorities with prio model — POST /prio-models/{id}/recalculate
Delete prio model — DELETE /prio-models/{prio_model}
Get prio model — GET /prio-models/{prio_model}
Update prio model — PATCH /prio-models/{prio_model}
Update prio model — PUT /prio-models/{prio_model}

Projects

List projects — GET /projects
Create project — POST /projects
Delete project — DELETE /projects/{project}
Get project — GET /projects/{project}
Update project — PATCH /projects/{project}
Update project — POST /projects/{project}
Update project — PUT /projects/{project}

Research Collections

List research collections — GET /research-collections
Create research collection — POST /research-collections
Delete research collection — DELETE /research-collections/{research_collection}
Get research collection — GET /research-collections/{research_collection}
Update research collection — PATCH /research-collections/{research_collection}
Update research collection — POST /research-collections/{research_collection}
Update research collection — PUT /research-collections/{research_collection}