# REST API reference The supported core data and reporting API, generated from the Laravel application. [Download OpenAPI](https://conversionlab.app/docs/openapi.json). 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](https://conversionlab.app/docs/developer/api/get-activities) — `GET /activities` ## Attachments - [List attachments](https://conversionlab.app/docs/developer/api/get-attachments) — `GET /attachments` - [Create attachment](https://conversionlab.app/docs/developer/api/post-attachments) — `POST /attachments` - [Delete attachment](https://conversionlab.app/docs/developer/api/delete-attachments-attachment) — `DELETE /attachments/{attachment}` - [Get attachment](https://conversionlab.app/docs/developer/api/get-attachments-attachment) — `GET /attachments/{attachment}` - [Update attachment](https://conversionlab.app/docs/developer/api/patch-attachments-attachment) — `PATCH /attachments/{attachment}` - [Update attachment](https://conversionlab.app/docs/developer/api/put-attachments-attachment) — `PUT /attachments/{attachment}` - [List attachments](https://conversionlab.app/docs/developer/api/get-type-id-attachments) — `GET /{type}/{id}/attachments` ## Audiences - [List audiences](https://conversionlab.app/docs/developer/api/get-audiences) — `GET /audiences` - [Create audience](https://conversionlab.app/docs/developer/api/post-audiences) — `POST /audiences` - [Delete audience](https://conversionlab.app/docs/developer/api/delete-audiences-audience) — `DELETE /audiences/{audience}` - [Get audience](https://conversionlab.app/docs/developer/api/get-audiences-audience) — `GET /audiences/{audience}` - [Update audience](https://conversionlab.app/docs/developer/api/patch-audiences-audience) — `PATCH /audiences/{audience}` - [Update audience](https://conversionlab.app/docs/developer/api/put-audiences-audience) — `PUT /audiences/{audience}` ## Comments - [List comments](https://conversionlab.app/docs/developer/api/get-comments) — `GET /comments` - [Create comment](https://conversionlab.app/docs/developer/api/post-comments) — `POST /comments` - [Delete comment](https://conversionlab.app/docs/developer/api/delete-comments-comment) — `DELETE /comments/{comment}` - [Update comment](https://conversionlab.app/docs/developer/api/patch-comments-comment) — `PATCH /comments/{comment}` - [Update comment](https://conversionlab.app/docs/developer/api/put-comments-comment) — `PUT /comments/{comment}` ## Daily Briefs - [Get daily brief](https://conversionlab.app/docs/developer/api/get-daily-briefs-today) — `GET /daily-briefs/today` ## Experiment States - [List experiment states](https://conversionlab.app/docs/developer/api/get-experiment-states) — `GET /experiment-states` - [Create experiment state](https://conversionlab.app/docs/developer/api/post-experiment-states) — `POST /experiment-states` - [Reorder experiment states](https://conversionlab.app/docs/developer/api/put-experiment-states-order) — `PUT /experiment-states/order` - [Delete experiment state](https://conversionlab.app/docs/developer/api/delete-experiment-states-experiment-state) — `DELETE /experiment-states/{experiment_state}` - [Get experiment state](https://conversionlab.app/docs/developer/api/get-experiment-states-experiment-state) — `GET /experiment-states/{experiment_state}` - [Update experiment state](https://conversionlab.app/docs/developer/api/patch-experiment-states-experiment-state) — `PATCH /experiment-states/{experiment_state}` - [Update experiment state](https://conversionlab.app/docs/developer/api/put-experiment-states-experiment-state) — `PUT /experiment-states/{experiment_state}` ## Experiments - [List experiments](https://conversionlab.app/docs/developer/api/get-experiments) — `GET /experiments` - [Create experiment](https://conversionlab.app/docs/developer/api/post-experiments) — `POST /experiments` - [Apply a bulk action to experiments](https://conversionlab.app/docs/developer/api/post-experiments-bulk) — `POST /experiments/bulk` - [Delete experiment](https://conversionlab.app/docs/developer/api/delete-experiments-experiment) — `DELETE /experiments/{experiment}` - [Get experiment](https://conversionlab.app/docs/developer/api/get-experiments-experiment) — `GET /experiments/{experiment}` - [Update experiment](https://conversionlab.app/docs/developer/api/patch-experiments-experiment) — `PATCH /experiments/{experiment}` - [Update experiment](https://conversionlab.app/docs/developer/api/put-experiments-experiment) — `PUT /experiments/{experiment}` - [List experiment approvals](https://conversionlab.app/docs/developer/api/get-experiments-experiment-approvals) — `GET /experiments/{experiment}/approvals` - [Record experiment approvals](https://conversionlab.app/docs/developer/api/post-experiments-experiment-approvals) — `POST /experiments/{experiment}/approvals` - [Distribute traffic for experiment](https://conversionlab.app/docs/developer/api/post-experiments-experiment-distribute-traffic) — `POST /experiments/{experiment}/distribute-traffic` - [Get the result report for experiment](https://conversionlab.app/docs/developer/api/get-experiments-experiment-summary) — `GET /experiments/{experiment}/summary` - [Get result time series for experiment](https://conversionlab.app/docs/developer/api/get-experiments-experiment-timeseries) — `GET /experiments/{experiment}/timeseries` ## Forms - [List forms](https://conversionlab.app/docs/developer/api/get-forms) — `GET /forms` - [Create form](https://conversionlab.app/docs/developer/api/post-forms) — `POST /forms` - [Apply a bulk action to forms](https://conversionlab.app/docs/developer/api/post-forms-bulk) — `POST /forms/bulk` - [Duplicate form](https://conversionlab.app/docs/developer/api/post-forms-duplicate) — `POST /forms/duplicate` - [Delete form](https://conversionlab.app/docs/developer/api/delete-forms-form) — `DELETE /forms/{form}` - [Get form](https://conversionlab.app/docs/developer/api/get-forms-form) — `GET /forms/{form}` - [Update form](https://conversionlab.app/docs/developer/api/patch-forms-form) — `PATCH /forms/{form}` - [Update form](https://conversionlab.app/docs/developer/api/put-forms-form) — `PUT /forms/{form}` - [Get form](https://conversionlab.app/docs/developer/api/get-forms-form-response-summary) — `GET /forms/{form}/response-summary` - [Reset survey responses](https://conversionlab.app/docs/developer/api/delete-forms-form-responses) — `DELETE /forms/{form}/responses` - [List forms](https://conversionlab.app/docs/developer/api/get-forms-form-responses) — `GET /forms/{form}/responses` - [Export responses for form](https://conversionlab.app/docs/developer/api/get-forms-form-responses-export) — `GET /forms/{form}/responses/export` ## Idea States - [List idea states](https://conversionlab.app/docs/developer/api/get-idea-states) — `GET /idea-states` - [Create idea state](https://conversionlab.app/docs/developer/api/post-idea-states) — `POST /idea-states` - [Reorder idea states](https://conversionlab.app/docs/developer/api/put-idea-states-order) — `PUT /idea-states/order` - [Delete idea state](https://conversionlab.app/docs/developer/api/delete-idea-states-idea-state) — `DELETE /idea-states/{idea_state}` - [Get idea state](https://conversionlab.app/docs/developer/api/get-idea-states-idea-state) — `GET /idea-states/{idea_state}` - [Update idea state](https://conversionlab.app/docs/developer/api/patch-idea-states-idea-state) — `PATCH /idea-states/{idea_state}` - [Update idea state](https://conversionlab.app/docs/developer/api/put-idea-states-idea-state) — `PUT /idea-states/{idea_state}` ## Ideas - [List ideas](https://conversionlab.app/docs/developer/api/get-ideas) — `GET /ideas` - [Create idea](https://conversionlab.app/docs/developer/api/post-ideas) — `POST /ideas` - [Apply a bulk action to ideas](https://conversionlab.app/docs/developer/api/post-ideas-bulk) — `POST /ideas/bulk` - [Delete idea](https://conversionlab.app/docs/developer/api/delete-ideas-idea) — `DELETE /ideas/{idea}` - [Get idea](https://conversionlab.app/docs/developer/api/get-ideas-idea) — `GET /ideas/{idea}` - [Update idea](https://conversionlab.app/docs/developer/api/patch-ideas-idea) — `PATCH /ideas/{idea}` - [Update idea](https://conversionlab.app/docs/developer/api/put-ideas-idea) — `PUT /ideas/{idea}` ## Insight Labels - [List insight labels](https://conversionlab.app/docs/developer/api/get-insight-labels) — `GET /insight-labels` - [Create insight label](https://conversionlab.app/docs/developer/api/post-insight-labels) — `POST /insight-labels` - [Delete insight label](https://conversionlab.app/docs/developer/api/delete-insight-labels-insight-label) — `DELETE /insight-labels/{insight_label}` - [Get insight label](https://conversionlab.app/docs/developer/api/get-insight-labels-insight-label) — `GET /insight-labels/{insight_label}` - [Update insight label](https://conversionlab.app/docs/developer/api/patch-insight-labels-insight-label) — `PATCH /insight-labels/{insight_label}` - [Update insight label](https://conversionlab.app/docs/developer/api/put-insight-labels-insight-label) — `PUT /insight-labels/{insight_label}` ## Insights - [List insights](https://conversionlab.app/docs/developer/api/get-insights) — `GET /insights` - [Create insight](https://conversionlab.app/docs/developer/api/post-insights) — `POST /insights` - [Apply a bulk action to insights](https://conversionlab.app/docs/developer/api/post-insights-bulk) — `POST /insights/bulk` - [Delete insight](https://conversionlab.app/docs/developer/api/delete-insights-insight) — `DELETE /insights/{insight}` - [Get insight](https://conversionlab.app/docs/developer/api/get-insights-insight) — `GET /insights/{insight}` - [Update insight](https://conversionlab.app/docs/developer/api/patch-insights-insight) — `PATCH /insights/{insight}` - [Update insight](https://conversionlab.app/docs/developer/api/put-insights-insight) — `PUT /insights/{insight}` ## Learnings - [List learnings](https://conversionlab.app/docs/developer/api/get-learnings) — `GET /learnings` - [Create learning](https://conversionlab.app/docs/developer/api/post-learnings) — `POST /learnings` - [Apply a bulk action to learnings](https://conversionlab.app/docs/developer/api/post-learnings-bulk) — `POST /learnings/bulk` - [Delete learning](https://conversionlab.app/docs/developer/api/delete-learnings-learning) — `DELETE /learnings/{learning}` - [Get learning](https://conversionlab.app/docs/developer/api/get-learnings-learning) — `GET /learnings/{learning}` - [Update learning](https://conversionlab.app/docs/developer/api/patch-learnings-learning) — `PATCH /learnings/{learning}` - [Update learning](https://conversionlab.app/docs/developer/api/put-learnings-learning) — `PUT /learnings/{learning}` ## Metrics - [List metrics](https://conversionlab.app/docs/developer/api/get-metrics) — `GET /metrics` - [Create metric](https://conversionlab.app/docs/developer/api/post-metrics) — `POST /metrics` - [Delete metric](https://conversionlab.app/docs/developer/api/delete-metrics-metric) — `DELETE /metrics/{metric}` - [Get metric](https://conversionlab.app/docs/developer/api/get-metrics-metric) — `GET /metrics/{metric}` - [Update metric](https://conversionlab.app/docs/developer/api/patch-metrics-metric) — `PATCH /metrics/{metric}` - [Update metric](https://conversionlab.app/docs/developer/api/put-metrics-metric) — `PUT /metrics/{metric}` ## Numbering Schemes - [List numbering schemes](https://conversionlab.app/docs/developer/api/get-numbering-schemes) — `GET /numbering-schemes` - [Create numbering scheme](https://conversionlab.app/docs/developer/api/post-numbering-schemes) — `POST /numbering-schemes` - [Preview numbering scheme](https://conversionlab.app/docs/developer/api/post-numbering-schemes-preview) — `POST /numbering-schemes/preview` - [Update numbering scheme](https://conversionlab.app/docs/developer/api/patch-numbering-schemes-numberingscheme) — `PATCH /numbering-schemes/{numberingScheme}` - [Update numbering scheme](https://conversionlab.app/docs/developer/api/put-numbering-schemes-numberingscheme) — `PUT /numbering-schemes/{numberingScheme}` - [Backfill identifiers using numbering scheme](https://conversionlab.app/docs/developer/api/post-numbering-schemes-numberingscheme-backfill) — `POST /numbering-schemes/{numberingScheme}/backfill` ## Observations - [List observations](https://conversionlab.app/docs/developer/api/get-observations) — `GET /observations` - [Create observation](https://conversionlab.app/docs/developer/api/post-observations) — `POST /observations` - [Apply a bulk action to observations](https://conversionlab.app/docs/developer/api/post-observations-bulk) — `POST /observations/bulk` - [Delete observation](https://conversionlab.app/docs/developer/api/delete-observations-observation) — `DELETE /observations/{observation}` - [Get observation](https://conversionlab.app/docs/developer/api/get-observations-observation) — `GET /observations/{observation}` - [Update observation](https://conversionlab.app/docs/developer/api/patch-observations-observation) — `PATCH /observations/{observation}` - [Update observation](https://conversionlab.app/docs/developer/api/put-observations-observation) — `PUT /observations/{observation}` - [Accept observation](https://conversionlab.app/docs/developer/api/post-observations-observation-accept) — `POST /observations/{observation}/accept` - [Dismiss observation](https://conversionlab.app/docs/developer/api/post-observations-observation-dismiss) — `POST /observations/{observation}/dismiss` - [Permanently delete an archived observation](https://conversionlab.app/docs/developer/api/delete-observations-observation-force) — `DELETE /observations/{observation}/force` - [Restore an archived observation](https://conversionlab.app/docs/developer/api/post-observations-observation-restore) — `POST /observations/{observation}/restore` - [Restore a dismissed observation](https://conversionlab.app/docs/developer/api/post-observations-observation-restore-dismissal) — `POST /observations/{observation}/restore-dismissal` ## Pages - [List pages](https://conversionlab.app/docs/developer/api/get-pages) — `GET /pages` - [Create page](https://conversionlab.app/docs/developer/api/post-pages) — `POST /pages` - [Delete page](https://conversionlab.app/docs/developer/api/delete-pages-page) — `DELETE /pages/{page}` - [Get page](https://conversionlab.app/docs/developer/api/get-pages-page) — `GET /pages/{page}` - [Update page](https://conversionlab.app/docs/developer/api/patch-pages-page) — `PATCH /pages/{page}` - [Update page](https://conversionlab.app/docs/developer/api/put-pages-page) — `PUT /pages/{page}` ## Prio Models - [List prio models](https://conversionlab.app/docs/developer/api/get-prio-models) — `GET /prio-models` - [Create prio model](https://conversionlab.app/docs/developer/api/post-prio-models) — `POST /prio-models` - [Validate the formula for prio model](https://conversionlab.app/docs/developer/api/post-prio-models-validate-formula) — `POST /prio-models/validate-formula` - [Recalculate priorities with prio model](https://conversionlab.app/docs/developer/api/post-prio-models-id-recalculate) — `POST /prio-models/{id}/recalculate` - [Delete prio model](https://conversionlab.app/docs/developer/api/delete-prio-models-prio-model) — `DELETE /prio-models/{prio_model}` - [Get prio model](https://conversionlab.app/docs/developer/api/get-prio-models-prio-model) — `GET /prio-models/{prio_model}` - [Update prio model](https://conversionlab.app/docs/developer/api/patch-prio-models-prio-model) — `PATCH /prio-models/{prio_model}` - [Update prio model](https://conversionlab.app/docs/developer/api/put-prio-models-prio-model) — `PUT /prio-models/{prio_model}` ## Projects - [List projects](https://conversionlab.app/docs/developer/api/get-projects) — `GET /projects` - [Create project](https://conversionlab.app/docs/developer/api/post-projects) — `POST /projects` - [Delete project](https://conversionlab.app/docs/developer/api/delete-projects-project) — `DELETE /projects/{project}` - [Get project](https://conversionlab.app/docs/developer/api/get-projects-project) — `GET /projects/{project}` - [Update project](https://conversionlab.app/docs/developer/api/patch-projects-project) — `PATCH /projects/{project}` - [Update project](https://conversionlab.app/docs/developer/api/post-projects-project) — `POST /projects/{project}` - [Update project](https://conversionlab.app/docs/developer/api/put-projects-project) — `PUT /projects/{project}` ## Research Collections - [List research collections](https://conversionlab.app/docs/developer/api/get-research-collections) — `GET /research-collections` - [Create research collection](https://conversionlab.app/docs/developer/api/post-research-collections) — `POST /research-collections` - [Delete research collection](https://conversionlab.app/docs/developer/api/delete-research-collections-research-collection) — `DELETE /research-collections/{research_collection}` - [Get research collection](https://conversionlab.app/docs/developer/api/get-research-collections-research-collection) — `GET /research-collections/{research_collection}` - [Update research collection](https://conversionlab.app/docs/developer/api/patch-research-collections-research-collection) — `PATCH /research-collections/{research_collection}` - [Update research collection](https://conversionlab.app/docs/developer/api/post-research-collections-research-collection) — `POST /research-collections/{research_collection}` - [Update research collection](https://conversionlab.app/docs/developer/api/put-research-collections-research-collection) — `PUT /research-collections/{research_collection}` ## Roadmap Annotations - [List roadmap annotations](https://conversionlab.app/docs/developer/api/get-roadmap-annotations) — `GET /roadmap-annotations` - [Create roadmap annotation](https://conversionlab.app/docs/developer/api/post-roadmap-annotations) — `POST /roadmap-annotations` - [Delete roadmap annotation](https://conversionlab.app/docs/developer/api/delete-roadmap-annotations-roadmap-annotation) — `DELETE /roadmap-annotations/{roadmap_annotation}` - [Get roadmap annotation](https://conversionlab.app/docs/developer/api/get-roadmap-annotations-roadmap-annotation) — `GET /roadmap-annotations/{roadmap_annotation}` - [Update roadmap annotation](https://conversionlab.app/docs/developer/api/patch-roadmap-annotations-roadmap-annotation) — `PATCH /roadmap-annotations/{roadmap_annotation}` - [Update roadmap annotation](https://conversionlab.app/docs/developer/api/put-roadmap-annotations-roadmap-annotation) — `PUT /roadmap-annotations/{roadmap_annotation}` ## Screen Annotations - [List screen annotations](https://conversionlab.app/docs/developer/api/get-screen-annotations) — `GET /screen-annotations` - [Create screen annotation](https://conversionlab.app/docs/developer/api/post-screen-annotations) — `POST /screen-annotations` - [Delete screen annotation](https://conversionlab.app/docs/developer/api/delete-screen-annotations-screen-annotation) — `DELETE /screen-annotations/{screen_annotation}` - [Get screen annotation](https://conversionlab.app/docs/developer/api/get-screen-annotations-screen-annotation) — `GET /screen-annotations/{screen_annotation}` - [Update screen annotation](https://conversionlab.app/docs/developer/api/patch-screen-annotations-screen-annotation) — `PATCH /screen-annotations/{screen_annotation}` - [Update screen annotation](https://conversionlab.app/docs/developer/api/put-screen-annotations-screen-annotation) — `PUT /screen-annotations/{screen_annotation}` ## Screens - [List screens](https://conversionlab.app/docs/developer/api/get-screens) — `GET /screens` - [Create screen](https://conversionlab.app/docs/developer/api/post-screens) — `POST /screens` - [Delete screen](https://conversionlab.app/docs/developer/api/delete-screens-screen) — `DELETE /screens/{screen}` - [Get screen](https://conversionlab.app/docs/developer/api/get-screens-screen) — `GET /screens/{screen}` - [Update screen](https://conversionlab.app/docs/developer/api/patch-screens-screen) — `PATCH /screens/{screen}` - [Update screen](https://conversionlab.app/docs/developer/api/put-screens-screen) — `PUT /screens/{screen}` ## Tags - [List tags](https://conversionlab.app/docs/developer/api/get-tags) — `GET /tags` - [Create tag](https://conversionlab.app/docs/developer/api/post-tags) — `POST /tags` - [Delete tag](https://conversionlab.app/docs/developer/api/delete-tags-tag) — `DELETE /tags/{tag}` - [Get tag](https://conversionlab.app/docs/developer/api/get-tags-tag) — `GET /tags/{tag}` - [Update tag](https://conversionlab.app/docs/developer/api/patch-tags-tag) — `PATCH /tags/{tag}` - [Update tag](https://conversionlab.app/docs/developer/api/put-tags-tag) — `PUT /tags/{tag}` ## User - [Get the authenticated user](https://conversionlab.app/docs/developer/api/get-user) — `GET /user` ## Variations - [List variations](https://conversionlab.app/docs/developer/api/get-variations) — `GET /variations` - [Create variation](https://conversionlab.app/docs/developer/api/post-variations) — `POST /variations` - [Delete variation](https://conversionlab.app/docs/developer/api/delete-variations-variation) — `DELETE /variations/{variation}` - [Get variation](https://conversionlab.app/docs/developer/api/get-variations-variation) — `GET /variations/{variation}` - [Update variation](https://conversionlab.app/docs/developer/api/patch-variations-variation) — `PATCH /variations/{variation}` - [Update variation](https://conversionlab.app/docs/developer/api/put-variations-variation) — `PUT /variations/{variation}`