{
  "opencollection": "1.0.0",
  "info": {
    "name": "Convert Accounts Domains API",
    "version": "2.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Domains",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List domains associated with a project",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.convert.com/api/v2/accounts/:account_id/projects/:project_id/domains",
            "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 website domains configured for a specific project.\nThe Convert tracking script will operate on these domains to run experiences and track visitors.\nWildcard domains (e.g., `*.example.com`) are supported.\nAs per the Knowledge Base: \"Active Websites: The domains you would like to use inside the project. Make sure you always add new domains here...\"\n"
        },
        {
          "info": {
            "name": "Get details for a specific domain in a project",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.convert.com/api/v2/accounts/:account_id/projects/:project_id/domains/:domain_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 domain is stored"
              },
              {
                "name": "domain_id",
                "value": "",
                "type": "path",
                "description": "ID of the domain to be retrieved"
              }
            ]
          },
          "docs": "Retrieves information about a single domain associated with a project, identified by its `domain_id`.\nThis includes the domain URL and whether the Convert tracking code was detected on it.\n"
        },
        {
          "info": {
            "name": "Get domain details by its URL",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.convert.com/api/v2/accounts/:account_id/projects/:project_id/domains/by_url",
            "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 domain is stored"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Retrieves information about a domain by matching its URL (exact or wildcard) instead of its ID.\nUseful if you know the domain URL but not its internal Convert ID.\n"
        },
        {
          "info": {
            "name": "Verify Convert tracking code installation on a domain",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.convert.com/api/v2/accounts/:account_id/projects/:project_id/domains/:domain_id/check_code",
            "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 domain is stored"
              },
              {
                "name": "domain_id",
                "value": "",
                "type": "path",
                "description": "ID of the domain to which the given URL belongs. An error would be returned if the URL is not under this domain."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Checks if the Convert tracking script for the specified project is correctly installed and detectable on the given URL (which must belong to the domain identified by `domain_id`).\nUpdates the `code_installed` status of the domain object.\nThe Knowledge Base article \"Tracking Script Installation Verification\" describes this UI feature.\n"
        },
        {
          "info": {
            "name": "Add a new domain to a project",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.convert.com/api/v2/accounts/:account_id/projects/:project_id/domains/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 domain is to be stored"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Associates a new website domain (e.g., `https://www.example.com`) with the specified project.\nThe Convert tracking script for this project should then be installed on this domain to enable experiments.\nWildcards like `https://*.example.com` can be used to include all subdomains.\n"
        },
        {
          "info": {
            "name": "Update an existing domain in a project",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.convert.com/api/v2/accounts/:account_id/projects/:project_id/domains/:domain_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 domain is to be stored"
              },
              {
                "name": "domain_id",
                "value": "",
                "type": "path",
                "description": "ID of the domain to be updated"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Modifies the URL of an existing domain associated with a project.\n"
        },
        {
          "info": {
            "name": "Remove a domain from a project",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.convert.com/api/v2/accounts/:account_id/projects/:project_id/domains/:domain_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 into which the domain is to be stored"
              },
              {
                "name": "domain_id",
                "value": "",
                "type": "path",
                "description": "ID of the domain to be delete"
              }
            ]
          },
          "docs": "De-associates a domain from the specified project.\nAfter deletion, Convert experiences will no longer run on this domain for this project.\n"
        },
        {
          "info": {
            "name": "Remove multiple domains from a project",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.convert.com/api/v2/accounts/:account_id/projects/:project_id/domains/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": "De-associates multiple domains from the specified project in a single operation.\nRequires a list of domain IDs to be removed.\n"
        }
      ]
    }
  ],
  "bundled": true
}