{
  "opencollection": "1.0.0",
  "info": {
    "name": "Convert Accounts Observations API",
    "version": "2.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Observations",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List observations within a project",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.convert.com/api/v2/accounts/:account_id/projects/:project_id/observations",
            "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 observations recorded for a specific project.\nObservations are initial insights, ideas, or user behaviors noted by the team, which can later be developed into hypotheses.\nSupports filtering by status, name, tags, and pagination.\nThe Knowledge Base article \"Observations Feature Guide\" explains: \"Observations - Document initial insights directly.\"\n"
        },
        {
          "info": {
            "name": "Get details for a specific observation",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.convert.com/api/v2/accounts/:account_id/projects/:project_id/observations/:observation_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 observation is stored"
              },
              {
                "name": "observation_id",
                "value": "",
                "type": "path",
                "description": "ID of the observation 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 observation, identified by its `observation_id`.\nThis includes its name, description, reference URL, status, associated tags, and any attachments (images/files).\n"
        },
        {
          "info": {
            "name": "Create a new observation",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.convert.com/api/v2/accounts/:account_id/projects/:project_id/observations/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 observation 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": "Records a new observation within a project.\nRequires a name, and can include a description, reference URL, status, tags, and attachments (images/files).\nObservations are the first step in the ideation process, leading to hypotheses.\nThe Knowledge Base article \"Observations Feature Guide\" details this: \"Observations serve as the starting point in documenting insights.\"\n"
        },
        {
          "info": {
            "name": "Update an existing observation",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.convert.com/api/v2/accounts/:account_id/projects/:project_id/observations/:observation_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 observation is to be updated"
              },
              {
                "name": "observation_id",
                "value": "",
                "type": "path",
                "description": "ID of the observation 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 observation, such as its name, description, URL, status, tags, or attachments.\n"
        },
        {
          "info": {
            "name": "Delete an observation",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.convert.com/api/v2/accounts/:account_id/projects/:project_id/observations/:observation_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 observation is to be deleted"
              },
              {
                "name": "observation_id",
                "value": "",
                "type": "path",
                "description": "ID of the observation to be deleted"
              }
            ]
          },
          "docs": "Permanently removes an observation from a project. This action is irreversible.\n"
        },
        {
          "info": {
            "name": "Update multiple observations at once",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.convert.com/api/v2/accounts/:account_id/projects/:project_id/observations/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 (e.g., active, archived) of multiple observations within a project simultaneously.\nRequires a list of observation IDs and the target status.\n"
        },
        {
          "info": {
            "name": "Delete multiple observations at once",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.convert.com/api/v2/accounts/:account_id/projects/:project_id/observations/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 observations from a project in a single operation.\nRequires a list of observation IDs. This action is irreversible.\n"
        }
      ]
    }
  ],
  "bundled": true
}