{
  "opencollection": "1.0.0",
  "info": {
    "name": "Convert Accounts Hypotheses API",
    "version": "2.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Hypotheses",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List hypotheses within a project",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.convert.com/api/v2/accounts/:account_id/projects/:project_id/hypotheses",
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path",
                "description": "ID of the account that owns the retrieved/saved data"
              },
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "ID of the project to which save/retrieved data is connected"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Retrieves a list of all hypotheses defined for a specific project.\nA hypothesis is an assumption about a proposed change and its expected impact, forming the basis for an experiment.\nSupports filtering by status, score, name, and pagination.\nThe Knowledge Base article \"Hypotheses (Compass)\" explains: \"A hypothesis is an assumption that a proposed change in your website would lead to visitors taking the action that you want them to.\"\n"
        },
        {
          "info": {
            "name": "Get details for a specific hypothesis",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.convert.com/api/v2/accounts/:account_id/projects/:project_id/hypotheses/:hypothesis_id",
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path",
                "description": "ID of the account that owns the retrieved/saved data"
              },
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "ID of the project into which the hypothesis is stored"
              },
              {
                "name": "hypothesis_id",
                "value": "",
                "type": "path",
                "description": "ID of the hypothesis to be retrieve"
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "Specifies the list of fields which would be expanded in the response. Otherwise, only their id would be returned.\n\nRead more in the section related to [Expanding Fields](#tag/Expandable-Fields)\n"
              }
            ]
          },
          "docs": "Retrieves detailed information about a single hypothesis, identified by its `hypothesis_id`.\nThis includes its name, objective, prioritization score (PIE or ICE), status, associated experiences, and tags.\n"
        },
        {
          "info": {
            "name": "Create a new hypothesis",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.convert.com/api/v2/accounts/:account_id/projects/:project_id/hypotheses/add",
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path",
                "description": "ID of the account that owns the retrieved/saved data"
              },
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "ID of the project into which the hypothesis is to be stored"
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "Specifies the list of objects which would be expanded in the response. Otherwise, only their id would be returned.\n\nRead more in the section related to [Expanding Fields](#tag/Expandable-Fields)\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Defines a new hypothesis within a project.\nRequires a name, objective (problem and proposed solution), prioritization model (PIE or ICE) and its scores, status, and optionally, start/end dates, summary, associated experiences, and tags.\nThe Knowledge Base article \"Hypotheses (Compass)\" details the PIE (Potential, Importance, Ease) and ICE (Impact, Confidence, Ease) models.\n"
        },
        {
          "info": {
            "name": "Update an existing hypothesis",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.convert.com/api/v2/accounts/:account_id/projects/:project_id/hypotheses/:hypothesis_id/update",
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path",
                "description": "ID of the account that owns the retrieved/saved data"
              },
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "ID of the project into which the hypothesis is to be updated"
              },
              {
                "name": "hypothesis_id",
                "value": "",
                "type": "path",
                "description": "ID of the hypothesis to be updated"
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "Specifies the list of objects which would be expanded in the response. Otherwise, only their id would be returned.\n\nRead more in the section related to [Expanding Fields](#tag/Expandable-Fields)\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Modifies the details of an existing hypothesis, such as its name, objective, prioritization scores, status, or associated experiences and tags.\n"
        },
        {
          "info": {
            "name": "Update the status of a hypothesis",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.convert.com/api/v2/accounts/:account_id/projects/:project_id/hypotheses/:hypothesis_id/update-status",
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path",
                "description": "ID of the account that owns the retrieved/saved data"
              },
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "ID of the project into which the hypothesis is stored"
              },
              {
                "name": "hypothesis_id",
                "value": "",
                "type": "path",
                "description": "ID of the hypothesis to be updated"
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "Specifies the list of objects which would be expanded in the response. Otherwise, only their id would be returned.\n\nRead more in the section related to [Expanding Fields](#tag/Expandable-Fields)\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Changes the status of an existing hypothesis (e.g., from 'draft' to 'completed', 'applied', 'proven', 'disproven', or 'archived').\nThis helps track the lifecycle of a hypothesis from idea to tested outcome.\n"
        },
        {
          "info": {
            "name": "Convert a proven/disproven hypothesis to a Knowledge Base entry",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.convert.com/api/v2/accounts/:account_id/projects/:project_id/hypotheses/:hypothesis_id/convert",
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path",
                "description": "ID of the account that owns the retrieved/saved data"
              },
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "ID of the project into which the hypothesis is going to be converted"
              },
              {
                "name": "hypothesis_id",
                "value": "",
                "type": "path",
                "description": "ID of the hypothesis to be converted"
              }
            ]
          },
          "docs": "Moves a hypothesis (typically one that is 'proven' or 'disproven' after testing) into the Knowledge Base.\nThis archives the learnings from the hypothesis for future reference and organizational learning.\nThe Knowledge Base article \"Hypotheses (Compass)\" mentions: \"Proven hypotheses can then be moved to the Knowledge Base\".\n"
        },
        {
          "info": {
            "name": "Delete a hypothesis",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.convert.com/api/v2/accounts/:account_id/projects/:project_id/hypotheses/:hypothesis_id/delete",
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path",
                "description": "ID of the account that owns the retrieved/saved data"
              },
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "ID of the project from which the hypothesis is to be deleted"
              },
              {
                "name": "hypothesis_id",
                "value": "",
                "type": "path",
                "description": "ID of the hypothesis to be deleted"
              }
            ]
          },
          "docs": "Permanently removes a hypothesis from a project. This action is irreversible.\n"
        },
        {
          "info": {
            "name": "Update multiple hypotheses at once",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.convert.com/api/v2/accounts/:account_id/projects/:project_id/hypotheses/bulk-update",
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path",
                "description": "ID of the account that owns the retrieved/saved data"
              },
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "ID of the project to which save/retrieved data is connected"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Allows for changing the status of multiple hypotheses within a project simultaneously.\nRequires a list of hypothesis IDs and the target status.\n"
        },
        {
          "info": {
            "name": "Delete multiple hypotheses at once",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.convert.com/api/v2/accounts/:account_id/projects/:project_id/hypotheses/bulk-delete",
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path",
                "description": "ID of the account that owns the retrieved/saved data"
              },
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "ID of the project to which save/retrieved data is connected"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Permanently removes multiple hypotheses from a project in a single operation.\nRequires a list of hypothesis IDs. This action is irreversible.\n"
        }
      ]
    }
  ],
  "bundled": true
}